Download the PHP package buexplain/mddoc without Composer
On this page you can find all versions of the php package buexplain/mddoc. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Please rate this library. Is it a good library?
Informations about the package mddoc
mddoc
这个是一个可以将markdown转换成html的包。 创建它的最初目的是用于管理接口文档,当然您也可以用于编写静态博客或其它场景。
快速体验
如果生成的html需要部署到站点的次级目录,则需要指定次级目录,请用 ./vendor/bin/mddoc.bat make -h
查看使用说明。
一个小案例
假设我们需要做一个文档管理,目录与文件结构如下:
composer require buexplain/mddoc "dev-master"
初始化项目,然后新建相关文件。
其中make.sh
的内容是:
README.md
的内容请参考README.md编写范例
然后运行 ./make.sh
,到这里,doc目录下的markdown文件就都转换成public目录里面的html文件了。然后搭建一个web服务器,将其根目录指向public目录即可。
注意事项
- 不支持自定义模板
- 不支持解析公式,点击查看支持的语法
- 目录列表的每一项目之间不能有空行。点击查看测试范例
- 如果需要将目录列表划分成多块,必须使用二级标题进行划分。点击查看测试范例
- 如果在Linux服务器上运行
./vendor/buexplain/mddoc/bin/mddoc
报错误没有那个文件或目录
,则是因为该文件的编码格式错误vim ./vendor/buexplain/mddoc/bin/mddoc
然后用命令set ff
可以查看到文件编码是fileformat=dos
,我们可以用命令set ff=unix
, 然后wq!
改变文件编码。 - 如果在Linux服务器上运行
./vendor/buexplain/mddoc/bin/mddoc
报错误/usr/bin/env: php: 没有那个文件或目录
,则是因为当前服务器的环境变量里面没有php命令导致的,配置php环境变量的方式,请自行使用搜索引擎获取答案。
二次开发相关
License
All versions of mddoc with dependencies
PHP Build Version
Package Version
Requires
php Version
>=7.0.0
symfony/console Version *
symfony/filesystem Version *
cebe/markdown Version *
symfony/console Version *
symfony/filesystem Version *
cebe/markdown Version *
The package buexplain/mddoc contains the following files
Loading the files please wait ....