aidantwoods/markdownphpdocs

PHP 的 Markdown 文档生成器

维护者

详细信息

github.com/aidantwoods/MarkdownPhpDocs

源代码

问题

安装次数: 1,271

依赖项: 0

建议者: 1

安全性: 0

星星: 1

关注者: 3

分支: 0

开放问题: 0

v0.2.1 2017-06-23 16:24 UTC

Requires

MIT 04d92936f0db6433da808a09f1a235dc1e3664bc

This package is auto-updated.

Last update: 2024-09-19 10:24:47 UTC

README

这是一个草率拼凑的包，用于从稍微定制版本的 phpdoc 生成 *.md 文件。

使用方法

Tutorial

安装

git clone https://github.com/aidantwoods/MarkdownPhpDocs
cd MarkdownPhpDocs
composer update

然后，您可以直接运行位于 bin 目录中的文件 markdown-phpdoc，或者将此 bin 目录添加到您的 ~/.bash_profile 中，以便在任何地方运行。例如，通过添加以下行

PATH="[local-file-path-goes-here]/MarkdownPhpDocs/bin:${PATH}"
export PATH

请注意，您需要 composer 来拉取定制版本的 phpdoc 作为依赖项（此处可用），这有助于禁用 phpdoc 中的 markdown 处理（这样做是为了避免 markdown 最终出现在 HTML 中，并且不被大多数 markdown 解析器忽略）。

用法

markdown-phpdoc -f [input file] -t [target directory]