宇润/mddoc

发布时间：2025-05-22 14:40

加入 Gitee

与超过 1200万开发者一起发现、参与优秀开源项目，私有仓库也完全免费：）

免费加入

克隆/下载

提示

下载代码请复制以下命令到终端执行

为确保你提交的代码身份被 Gitee 正确识别，请执行以下命令完成配置

使用 HTTPS 协议时，命令行会出现如下账号密码验证步骤。基于安全考虑，Gitee 建议配置并使用私人令牌替代登录密码进行克隆、推送等操作

Username for 'https://gitee.com': userName

Password for 'https://[email protected]': # 私人令牌

介绍

mddoc 是一个开源的 markdown 文档转 html 文档工具，它使用 php 开发，支持 php >= 5.4。它生成的 html 可以直接放在网站上，支持全文搜索、自定义 html 模版。

mddoc 同时支持命令行、git webhook生成，不光可以本地生成后上传，也可以直接做成 webhook 自动部署生成，非常简单。

mddoc 兼容 GitBook Editor 编辑的格式，可以说 mddoc 是不想装 Node 环境又想使用 gitbook 的用户的一个非常好的选择。

其实我开发 mddoc 的本意，其实是因为我用的虚拟主机，不能装 Node 环境。想要实现 webhook 自动生成比较困难，所以就用 php 写了这个……

具体效果你现在看的这个文档就是使用 mddoc 生成哒！（ https://doc.yurunsoft.com/mddoc ）

Github：https://github.com/Yurunsoft/mddoc

Gitee：https://gitee.com/yurunsoft/mddoc

composer：yurunsoft/mddoc

命令行生成

首先通过 git 将项目拉取下来执行composer update安装执行php build.php -markdownPath "md文档路径" -htmlPath "html生成路径"

注意！html生成目录在生成前会被清空所有文件，请慎重选择目录！

默认生成使用的模版是mddoc/template下的，如果要指定自定义的模版路径，加上参数-templatePath "路径"

The MIT License (MIT) Copyright (c) 2017 宇润 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

此处可能存在不合适展示的内容，页面不予展示。您可通过相关编辑功能自查并修改。

如您确认内容无涉及不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容，可点击提交进行申诉，我们将尽快为您处理。

开源的 markdown 文档转 html 文档工具，它使用 php 开发，支持 php >= 5.4。它生成的 html 可以直接放在网站上，支持全文搜索、自定义 html 模版。展开收起

马建仓 AI 助手