Skip to content

Lets WordPress admins create searchable, hierarchically-organized documentation. Supports Markdown and syntax highlighting for code. Requires WP MVC.

License

Notifications You must be signed in to change notification settings

tombenner/hierarchical-documentation

Repository files navigation

Hierarchical Documentation

Lets WordPress admins create searchable, hierarchically-organized documentation. Supports Markdown and syntax highlighting for code. Requires WP MVC.

Description

Hierarchical Documentation allows admins to create public pages of documentation and organize them hierarchically using a tree listing the pages where each page can be dragged to its desired position. It supports syntax highlighting for blocks of code and Markdown.

For an example of Hierarchical Documentation in action, see wpmvc.org.

Please note that the default behavior is to display the documentation page that has an ID of 1 as the site's homepage. This can be changed by editing the first line of hierarchical-documentation/app/config/routes.php. (See the WP MVC documentation page on routing for details.)

This plugin depends on WP MVC, so that plugin needs to be installed and activated before this one is activated.

If you'd like to grab development releases, see what new features are being added, or browse the source code please visit the GitHub repo.

Installation

  1. Upload hierarchical-documentation to the wp-content/plugins/ directory
  2. Activate the plugin through the 'Plugins' menu in WordPress

Frequently Asked Questions

Is feature X available?

This plugin was written quickly to make the documentation site for WP MVC and thus isn't terribly feature-rich or pretty. If you have any suggestions of features that could be added or changes that could be made, please feel free to either add a topic in the WordPress forum or contact me through GitHub:

About

Lets WordPress admins create searchable, hierarchically-organized documentation. Supports Markdown and syntax highlighting for code. Requires WP MVC.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published