gnowland/markdown-wordpress-docs

Generate WordPress website documentation from Markdown Files

Maintainers

Details

github.com/gnowland/markdown-wordpress-docs

Source

Issues

Installs: 0

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 2

Forks: 0

Open Issues: 2

Language:CSS

v1.0.0 2020-11-05 03:53 UTC

Requires

GPL-2.0-or-later 55905ffff4d045fa632ee4cfe54174c5b608d2a0

  • Gifford Nowland <hi.woop@giffordnowland.com>

This package is auto-updated.

Last update: 2024-05-05 13:47:58 UTC

README

GitHub release | Packagist | buymeacoffee.com/gnowland

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 ../[DOCUMENT_NAME.md], ./[DOCUMENT_NAME.md] or docs/[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.
  • The help page will be displayed in the Dashboard sub-menu

Installation

Composer

composer require gnowland/markdown-wordpress-documentation

Activate with wp-cli

wp plugin activate markdown-wordpress-documentation

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)