lts / php-book-markdown-tools
用于处理Markdown的工具,尤其针对书籍写作
dev-main
2021-10-27 12:19 UTC
Requires
- php: >= 8.0.1
- ext-curl: *
- thecodingmachine/safe: ^1.3
Requires (Dev)
- edmondscommerce/phpqa: dev-php8@dev
- phpmd/phpmd: dev-master@dev
- phpunit/phpunit: ^9.5
- roave/security-advisories: dev-latest@dev
This package is auto-updated.
Last update: 2024-09-27 19:12:25 UTC
README
一套辅助编写Markdown和嵌入代码等工具
专门为辅助编写我正在制作的PHP书籍而构建
目前这个库提供了以下功能
Markdown处理
此过程旨在就地更新Markdown文件
代码片段
可以通过指定相关PHP文件的路径来自动包含代码片段
代码片段也可以运行,并捕获输出并呈现在另一个代码块中。
为此,您必须以这种方式编写Markdown - 空白敏感
标准代码片段
以下内容将复制/粘贴文件内容到代码围栏区域。您必须预先创建空的代码围栏区域。每次运行该过程时,代码围栏区域将使用指定的文件中的代码更新。
路径来自Markdown文件所在的目录。
[Code Snippet](./../../../path/to/src/file.php) ```php ```
可执行代码片段
可执行片段与标准片段完全相同,但它还会创建一个输出块
[Code Executable Snippet](./../../../path/to/src/file.php) ```php ```
例如,完整的代码和输出片段将看起来像
[Code Executable Snippet](./itCanGetAndRunCodeSnippets.php) ```php <?php $foo=1; $bar=2; function add(int $a, int $b):int{ return $a+$b; }echo "And new we add some stuff"; echo add($foo, $bar); ``` ###### Output: ```terminal php itCanGetAndRunCodeSnippets.php And new we add some stuff3 ```
GitHub代码片段
您可以通过将GitHub代码页面的URL放入其中来引用本地代码,例如
每次运行该过程时,输出和代码片段区域都将更新。
块引用处理器
下一个主要功能是处理块引用。有几种类型的块引用被处理,尽管通常是