datashaman/lowdown

PHP项目的文档生成器

维护者

详细信息

github.com/datashaman/lowdown

源代码

问题

安装次数: 1

依赖者: 0

建议者: 0

安全: 0

星星: 0

观察者: 1

分支: 0

开放问题: 0

0.1.0 2019-05-13 05:58 UTC

Requires

Requires (Dev)

MIT 18e2ba968ac364acfd41f098d8c34ae8170c5d16

  • Marlin Forbes <marlinf.woop@datashaman.com>

documentationreflectionvuejsdocumentation-generator

This package is auto-updated.

Last update: 2024-09-14 03:58:42 UTC

README

Lowdown 将根据您在项目中提供的类型提示和PHPDoc注释或docblocks的详细程度生成文档。

所有 docblocks 都会通过一个 Markdown 解析器进行处理。

Lowdown 特别关注包含 <pre></pre> 块的函数和方法。

在 <pre></pre> 标签内的任何内容都被视为代码示例。

示例会动态提取和评估；输出将被保存以包含在文档中。

为了锦上添花，示例代码还可以作为 GitHub 上的gist发布。

文档中会生成一个链接，可以点击它作为 Melody 脚本运行。

安装

将composer包安装到您的项目中作为开发依赖

composer require --dev datashaman/lowdown

配置

将环境变量添加到您的 .env 文件中以配置构建过程。这些都是可选的。

  • LOWDOWN_DEST 文档写入的目标文件夹。默认为 docs/api。
  • LOWDOWN_GISTS_CACHED GitHub Gist请求应该被缓存。默认为 true。
  • LOWDOWN_GISTS_TOKEN GitHub个人访问令牌。用于生成Gists。
  • LOWDOWN_GISTS_USERNAME GitHub用户名。用于生成Gists。
  • LOWDOWN_SOURCES 生成文档的源文件夹。以逗号分隔。默认为 app,src。
  • LOWDOWN_WHITELIST 命名空间白名单。如果设置，则仅生成这些命名空间的文档。以逗号分隔。

构建

构建您的包文档

lowdown build

构建包含Gists的您的包文档

lowdown build --gist

服务

提供您的包文档服务

lowdown serve