A lightweight WordPress Plugin that generates admin documentation/help pages for your WordPress site from Markdown files.
- Add Markdown files to
docs/
- Install & Activate plugin in WordPress Admin
/docs
should contain all your Markdown files- Links to
../[DOCUMENT_NAME.md]
,./[DOCUMENT_NAME.md]
ordocs/[DOCUMENT_NAME.md]
will automatically route to display the file using URL Parameters?page=docs&doc=[DOCUMENT_NAME].md
- I recommend dividing files into subjects and including a Table of Contents in
docs/README.md
.
- I recommend dividing files into subjects and including a Table of Contents in
- The help page will be displayed in the Dashboard sub-menu
composer require gnowland/markdown-wordpress-documentation
Activate with wp-cli
wp plugin activate markdown-wordpress-documentation
or in the WordPress Admin panel.
git clone
into your sites plugin folder- Activate via WordPress or wp-cli (see above) or in WordPress Admin
- Download the latest release as a
.zip
file - Unzip to your sites plugin folder
- Activate via WordPress Admin or wp-cli (see above)