pentatonicfunk / wp-phpdoc-markdown
Create markdown from WordPress phpdoc, focused on hooks (action/filter). Forked from https://github.com/WordPress/phpdoc-parser
Installs: 0
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 4
Type:wordpress-plugin
Requires
- php: >=5.4
- webmozart/path-util: ^2.3
- wordpress/phpdoc-parser: dev-library-convert
This package is not auto-updated.
Last update: 2020-01-08 23:20:29 UTC
README
Create Markdown documentations for WordPress Code. Currently its only creating docs for hooks
. Functions
and Classes
not included yet.
History and Credits
This project is based on WordPress/phpdoc-parser.
Inline documentation should follow WordPress Best Practices
Sample Output : example.md
Requirements
Clone the repository into your WordPress plugins directory:
git clone git@github.com:pentatonicfunk/wp-phpdoc-markdown.git
After that install the dependencies using composer in the parser directory:
composer install
Running
Activate the plugin first:
wp plugin activate wp-phpdoc-markdown
In your site's directory / wp-phpdoc-markdown
directory:
wp wparser mdhooks <src_dir> <output_dir> [--json_doc=<json_doc>]
wp wparser mdhooks ../forminator/ ./../forminator/docs
Customization
All default used templates are placed in templates
To Customize it define this constant in your wp-config.php
define( 'WP_PHPDOC_MARKDOWN_TEMPLATE_TOC', '/path/to/toc.md' ); define( 'WP_PHPDOC_MARKDOWN_TEMPLATE_HOOK', __DIR__ . '/path/to/hook.md' ); define( 'WP_PHPDOC_MARKDOWN_TEMPLATE_HOOK_PARAMETERS', '/path/to/hook.parameters.md' ); define( 'WP_PHPDOC_MARKDOWN_TEMPLATE_HOOK_PARAMETER', '/path/to/hook.parameter.md' ); define( 'WP_PHPDOC_MARKDOWN_TEMPLATE_HOOK_CHANGELOGS', '/path/to/hook.changelogs.md' ); define( 'WP_PHPDOC_MARKDOWN_TEMPLATE_HOOK_CHANGELOG', '/path/to/hook.changelog.md' );
Usage Help
NAME
wp wparser mdhooks
DESCRIPTION
Generate a JSON file containing the PHPDoc markup, and create markdown docs of hooks on <output_dir>.
SYNOPSIS
wp wparser mdhooks <src_dir> <output_dir> [--json_doc=<json_doc>]
OPTIONS
<src_dir>
Source code directory
<output_dir>
Desired Output directory of markdown documents
[--json_doc=<json_doc>]
Where temporary generated json phpdoc will be created, default is /tmp/phpdoc.json
EXAMPLES
wp wparser mdhooks <src_dir> <output_dir> [--json_doc=<json_doc>]
wp wparser mdhooks ../forminator/ ./../forminator/docs --json_doc=/tmp/phpdoc.json