A plugin to which implements a documentation template and a handful of additional useful features to your WP site.
The plugin is intended to be used within a project which loads the Bootstrap 4 assets from the ASU Unity Project.
It has been tested and is compatible with the following themes:
- UDS-WordPress from ASU Knowledge Enterprise .
- Pitchfork from ASU Engineering.
Clone the lastest from the main branch or download a release from GitHub.
Dependancies from composer are included in the source code for the repo. No need for a build step.
This plugin leverages the following JS / Composer libraries for functionality delivered to the front end.
- The Hybrid Breadcrumbs composer-based assset for including breadcrumbs.
- The TOCBot project is responsible for the main document sidebar which highlights the headings within a published document for easier reference.
Table of Contents
- The links within the table-of-contents sidebar are dependent on all headings within the body of a document having
ids established. - WordPress 5.9.1 shipped with an expirimental feature which automatically creates
ids for any included heading block in a post/page. - WordPress 6.0 is expected to ship with a UI in the block editor which enables this feature by default.
- But, until then, please remember to add the ID element manually to all headings.
- Run
npm installandcomposer installprior to local development. - SASS and JS compile & watch tasks are triggered via WP-Gulp and
npm startfrom the project root.
- More style adjustments to the initial card layout at
/docs. Better spacing within each category card. - Links within
/docsarchive page now reflect the permalink for the document. - Added larger default top-margin to H2 elements within each document. Provides better visual separation between the different sections on the page.
- CSS adjustments to be inline with current version of Pitchfork theme (v1.1)
- Initial deployment of the plugin. 1.0.
- Quickly patched missing composer assets in the 1.1 release.