Skip to content

Latest commit

 

History

History
17 lines (9 loc) · 1.15 KB

File metadata and controls

17 lines (9 loc) · 1.15 KB

DocMan 简介

DocMan 是一个自由开源的文档站点生成器,它可以让我们优雅、简洁的生成和部署开发文档,API 接口文档,教程,笔记等多种类型的站点。

DocMan 依据文档项目的目录索引文件 index.json 将 Markdown 文档文件生成为一系列有组织的 HTML 站点文件。

01

DocMan 可以自动处理文档中引入的图片等资源,将其复制到发行目录,并相应的修改 HTML 元素的 hrefsrc 等属性。

我们可以拿 DocMan 与 Hexo 类比,Hexo 生成一整个博客网站,而 DocMan 生成文档站点或子站点。

个人开发者和团队可以很容易的定制 DocMan 主题,生成风格统一的文档站点。我们也提供一些优秀的 DocMan 官方主题供选择。

02

DocMan 希望人们可以专注于文档的编写,而无需在配置上耽误时间。因此 DocMan 的配置非常简单,我们最少进行一些基本配置(指定输入输出文件夹),就可以运行 DocMan 生成站点了。我们也可以进行额外的扩展配置,更详细的指定 DocMan 的生成行为。