abgeo/gen-md

Markdown文档生成库

维护者

详细信息

github.com/ABGEO/gen-md

主页

源代码

问题

资助包维护！
Patreon
Open Collective
www.paypal.me/ABGEO

安装: 81

依赖: 0

建议: 0

安全: 0

星标: 2

关注者: 2

分支: 1

开放问题: 1

v0.9 2019-08-30 08:34 UTC

MIT 7a7777e1fe9f37c37c3663433dfc5e2063ad8e20

  • ABGEO <takalandzet.woop@gmail.com>

generatorphpmarkdownmd

This package is auto-updated.

Last update: 2024-08-29 05:00:51 UTC

README

用于生成Markdown文档的PHP库

GitHub license GitHub release Packagist Version

PHP Innovation Award August 2020 Winner

安装

您可以使用 Composer 安装此库

  • composer require abgeo/gen-md

用法

在主文件中包含composer自动加载器（例如：index.php）

  • require_once __DIR__ . '/../vendor/autoload.php';

类

该库有两个类

  • \ABGEO\MDGenerator\Document - 用于生成Markdown文档；
  • \ABGEO\MDGenerator\Element - 用于生成Markdown元素；

类 Document

导入 ABGEO\MDGenerator\Document 类。

公共方法
  • addElement() - 向文档内容添加元素；
  • clear() - 清空文档内容；

注意：请参阅 example.php 中的用法。

类 Element

导入 ABGEO\MDGenerator\Element 类。

公共方法
  • concatenateElements() - 连接给定元素；
  • createHeading() - 创建标题元素；
  • createParagraph() - 创建段落元素；
  • createBreak() - 创建换行元素；
  • createBold() - 创建粗体元素；
  • createItalic() - 创建斜体元素；
  • createBoldAndItalic() - 创建粗体和斜体元素；
  • createBlockquote() - 创建引用元素；
  • createList() - 创建列表元素；
  • createLine() - 创建线条元素；
  • createLink() - 创建链接元素；
  • createImage() - 创建图片元素；

注意：请参阅 example.php 中的用法。

导出

ABGEO\MDGenerator\Document 类具有 export2File() 方法，该方法接受一个参数

  • 生成文档的文件路径。

示例

...
// Export document to file.
$document->export2File(__DIR__ . '/generated/example.MD');
...

示例

请参阅 example.php 中的完整示例。

作者

  • Temuri Takalandze - 初始工作 - ABGEO

许可证

本项目采用MIT许可证 - 有关详细信息，请参阅LICENSE 文件。