Install
This is the repository archive. It installs, but the folder name will carry the branch suffix and updates will not flow.
Install straight from GitHub with WP-CLI:
wp plugin install https://github.com/gnowland/markdown-wordpress-docs/archive/refs/heads/main.zipNo built-in updater. New versions won't appear under Dashboard → Updates. Install new releases yourself, or let Git Updater track the repository.
Markdown WordPress Docs
|
|
A lightweight WordPress Plugin that generates admin documentation/help pages for your WordPress site from Markdown files.
Use
1. Add Markdown files to docs/
2. Install & Activate plugin in WordPress Admin
Details
- /docs should contain all your Markdown files
- Links to ../[DOCUMENTNAME.md], ./[DOCUMENTNAME.md] or docs/[DOCUMENTNAME.md] will automatically route to display the file using URL Parameters ?page=docs&doc=[DOCUMENTNAME].md
- I recommend dividing files into subjects and including a Table of Contents in docs/README.md.
- The help page will be displayed in the Dashboard sub-menu
Installation ##
Composer ###
Activate with wp-cli
or in the WordPress Admin panel.
Git ###
git clone into your sites plugin folder
Activate via WordPress or wp-cli (see above) or in WordPress Admin
Manually ###
Download the latest release as a .zip file
Unzip to your sites plugin folder
Activate via WordPress Admin or wp-cli (see above)
Releases
1 release.
Tag
Published
v1.0.0
latest
Nov 5, 2020 5 years ago
These releases are tags only. The author does not attach a packaged zip, so there are no download counts to report.