mathiasverraes/uptodocs

UpToDocs 会扫描 Markdown 文件中的 PHP 代码块，并在单独的进程中执行每个代码块。将其包含到您的 CI 工作流程中，以确保您的文档始终与代码保持最新。

维护者

详细信息

github.com/mathiasverraes/uptodocs

主页

源代码

问题

资助包维护！
mathiasverraes

安装次数: 272

依赖项: 2

建议者: 0

安全: 0

星标: 57

关注者: 2

分支: 1

开放问题: 0

1.0.3 2020-06-12 07:59 UTC

Requires

MIT 173682f92e4ad108839b5282af969718c6e2fb12

documentationtestingci

This package is auto-updated.

Last update: 2024-09-19 19:54:55 UTC

README

UpToDocs 会扫描 Markdown 文件中的 PHP 代码块，并在单独的进程中执行每个代码块。

将其包含到您的 CI 工作流程中，以确保您的文档始终与代码保持最新。

使用说明

composer require --dev mathiasverraes/uptodocs

命令行界面

vendor/bin/uptodocs run [options] [--] <markdownFile>

Arguments:
  markdownFile          Markdown file to run.

Options:
  -b, --before=BEFORE   A PHP file to run before each code block. 
                        Useful for imports and other setup code.
  -a, --after=AFTER     A PHP file to run after each code block. 
                        Useful for cleanup, and for running assertions.

在您的代码中

<?php
$upToDocs = new Verraes\UpToDocs\UpToDocs();
$result = $upToDocs->run("README.md"); // bool

示例

您可以在示例目录中的 Markdown 文件上尝试它

./uptodocs run sample/docs.md --before sample/before.php

输出

The following code block in /Users/mathias/workspace/php/uptodocs/sample/docs.md:16 failed.
<?php
$v = multiplyy(10,2);

PHP Fatal error:  Uncaught Error: Call to undefined function multiplyy() in Standard input code:11
Stack trace:
#0 {main}
  thrown in Standard input code on line 11

UpToDocs 在我们的示例代码中发现了拼写错误。哎呀！