README

为WordPress代码创建Markdown文档。目前仅创建hooks文档。函数和类尚未包括。

历史和信用

本项目基于WordPress/phpdoc-parser。

内联文档应遵循WordPress最佳实践

示例输出：example.md

要求

• PHP 5.4+
• Composer
• WP CLI

将仓库克隆到您的WordPress插件目录

git clone git@github.com:pentatonicfunk/wp-phpdoc-markdown.git 

然后使用composer在解析器目录中安装依赖项

composer install

运行

首先激活插件

wp plugin activate wp-phpdoc-markdown

在您的网站目录 / wp-phpdoc-markdown 目录

wp wparser mdhooks <src_dir> <output_dir> [--json_doc=<json_doc>]
wp wparser mdhooks ../forminator/ ./../forminator/docs

自定义

所有默认使用的模板都放在templates

要自定义它，请在您的 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' );

使用帮助

名称

wp wparser mdhooks

描述

Generate a JSON file containing the PHPDoc markup, and create markdown docs of hooks on <output_dir>.

概要

wp wparser mdhooks <src_dir> <output_dir> [--json_doc=<json_doc>]

选项

<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

示例

wp wparser mdhooks <src_dir> <output_dir> [--json_doc=<json_doc>]
wp wparser mdhooks ../forminator/ ./../forminator/docs --json_doc=/tmp/phpdoc.json