PHPackages buexplain/mddoc - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. buexplain/mddoc ActiveLibrary[API Development](/categories/api) buexplain/mddoc =============== 这个是一个可以将markdown转换成html的包 v0.1.0(5y ago)152Apache-2.0PHPPHP >=7.0.0 Since Jun 16Pushed 5y ago1 watchersCompare [ Source](https://github.com/buexplain/mddoc)[ Packagist](https://packagist.org/packages/buexplain/mddoc)[ RSS](/packages/buexplain-mddoc/feed)WikiDiscussions master Synced 5d ago READMEChangelogDependencies (4)Versions (2)Used By (0) mddoc ===== [](#mddoc) 这个是一个可以将markdown转换成html的包。 创建它的最初目的是用于管理接口文档，当然您也可以用于编写静态博客或其它场景。 快速体验 ---- [](#快速体验) ``` # 下载包 composer require buexplain/mddoc # 创建存储html的文件夹 mkdir doc # 根据markdown文档生成html文件，linux下将 mddoc.bat 替换为 mddoc ./vendor/bin/mddoc.bat make ./vendor/buexplain/mddoc/tests ./doc # 启动web服务器 php -S 127.0.0.1:1991 -t ./doc # 浏览器打开 http://127.0.0.1:1991/index.html 查看效果 ``` 如果生成的html需要部署到站点的次级目录，则需要指定次级目录，请用 `./vendor/bin/mddoc.bat make -h` 查看使用说明。 一个小案例 ----- [](#一个小案例) 假设我们需要做一个文档管理，目录与文件结构如下： ``` E:. │ composer.json │ composer.lock │ make.sh │ ├─doc │ README.md │ └─public ``` `composer require buexplain/mddoc "dev-master"`初始化项目，然后新建相关文件。 其中`make.sh`的内容是： ``` #!/bin/bash rm -rf public/* chmod u+x ./vendor/bin/mddoc chmod u+x ./vendor/buexplain/mddoc/bin/mddoc ./vendor/bin/mddoc make ./doc/ ./public README.md ./ ``` `README.md`的内容请参考[README.md编写范例](https://github.com/buexplain/mddoc/blob/master/tests/README.md)然后运行 `./make.sh`，到这里，doc目录下的markdown文件就都转换成public目录里面的html文件了。然后搭建一个web服务器，将其根目录指向public目录即可。 注意事项 ---- [](#注意事项) 1. 不支持自定义模板 2. 不支持解析公式，[点击查看支持的语法](https://github.com/buexplain/mddoc/blob/master/tests/test1_one_2.md) 3. 目录列表的每一项目之间不能有空行。[点击查看测试范例](https://github.com/buexplain/mddoc/blob/master/tests/README.md) 4. 如果需要将目录列表划分成多块，必须使用二级标题进行划分。[点击查看测试范例](https://github.com/buexplain/mddoc/blob/master/tests/README.md) 5. 如果在Linux服务器上运行`./vendor/buexplain/mddoc/bin/mddoc`报错误`没有那个文件或目录`，则是因为该文件的编码格式错误 `vim ./vendor/buexplain/mddoc/bin/mddoc`然后用命令`set ff`可以查看到文件编码是`fileformat=dos`，我们可以用命令`set ff=unix`， 然后`wq!`改变文件编码。 6. 如果在Linux服务器上运行`./vendor/buexplain/mddoc/bin/mddoc`报错误`/usr/bin/env: php: 没有那个文件或目录`，则是因为当前服务器的环境变量里面没有php命令导致的，配置php环境变量的方式，请自行使用搜索引擎获取答案。 二次开发相关 ------ [](#二次开发相关) ``` # 运行测试数据 cd ./tests && mkdir doc & cd ../ && php bin/mddoc make ./tests ./tests/doc README.md ./tests/doc & echo http://127.0.0.1:1991/tests/doc/index.html && php -S 127.0.0.1:1991 ``` License ------- [](#license) [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0.html) ### Health Score 21 — LowBetter than 19% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity10 Limited adoption so far Community7 Small or concentrated contributor base Maturity40 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Unknown Total 1 Last Release 2161d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/3b5d9484a14b3718c89b908f5dfc3560c4cbf0c4a879ea77a53c708aead2b2f4?d=identicon)[buexplain](/maintainers/buexplain) --- Top Contributors [![buexplain](https://avatars.githubusercontent.com/u/12883364?v=4)](https://github.com/buexplain "buexplain (26 commits)") --- Tags converterhtmlmarkdownphpapihtmldocmarkdown ### Code Quality Code StylePHP CS Fixer ### Embed Badge ![Health badge](/badges/buexplain-mddoc/health.svg) ``` [![Health](https://phpackages.com/badges/buexplain-mddoc/health.svg)](https://phpackages.com/packages/buexplain-mddoc) ``` ### Alternatives [linkorb/etcd-php Etcd client library for PHP 243143.4k1](/packages/linkorb-etcd-php)[hg/apidoc 根据注解生成API文档，兼容Laravel、ThinkPHP、Hyperf、Webman等框架；在线调试、Markdown文档、多应用/多版本、Mock数据、授权访问、接口生成器、代码生成器等众多实用功能 22485.8k1](/packages/hg-apidoc)[harmbandstra/swagger-ui-bundle Exposes swagger UI inside your Symfony project through a route (eg. /docs) 42867.3k](/packages/harmbandstra-swagger-ui-bundle)[hg/apidoc-thinkphp thinkphp API文档自动生成 1311.8k](/packages/hg-apidoc-thinkphp) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)