flsouto/md2php

此包的最新版本（1.0.0）没有可用的许可证信息。

从Markdown文件中提取PHP代码块并保存为整齐的格式

维护者

详细信息

github.com/flsouto/md2php

源代码

问题

安装: 18

依赖项: 0

建议者: 0

安全性: 0

星星: 2

关注者: 1

分支: 1

开放问题: 1

1.0.0 2016-10-23 02:02 UTC

Unknown License 8353723a6f79fb3f6d812836b9a31aec6b197174

  • Fabio Souto <fabiolimasouto.woop@gmail.com>

markdowncodetoolcommand-linesnippets

This package is not auto-updated.

Last update: 2024-09-18 18:58:57 UTC

README

这是什么

这是一个命令行工具，允许您从Markdown文件中提取PHP代码片段并将其保存到目录中。为了使代码片段匹配并从Markdown中提取，它必须以<?php或<?开头。

安装

使用composer安装此工具

composer require flsouto/md2php

用法

首先创建一个目录，该目录将存储从Markdown文件中提取的所有片段

$ mkdir snippets

然后调用提取程序，告知要从中提取的Markdown文件和要写入的目录

$ php vendor/flsouto/md2php/extract.php README.md ./snippets

例如，我使用上面的命令处理了我的一个仓库的文档：[README.md](https://raw.githubusercontent.com/flsouto/array2options/master/README.md)

输出如下

Extracting snippet to ./snippets/01-array2options.php 
Extracting snippet to ./snippets/02-selecting_option.php 
Extracting snippet to ./snippets/03-using_associative_arrays.php 
Extracting snippet to ./snippets/04-converting_datasets_options.php 
Total snippets extracted: 4

注意代码片段按在文档中的出现顺序命名。注意，它使用在到达代码片段之前匹配的最后一个标题作为文件名。

完成此操作后，您可以直接从终端本身运行提取的片段

$ php snippets/01-array2options.php

最终想法

我发现这个工具在编写如本例的README文档时非常有用，因为我在编写过程中可以运行示例代码块，而无需不断复制和粘贴片段。