轻松记录您
灵感和创意

markdown制作文档

Markdown 非常适合技术文档。像 GitHub 这样的公司越来越多地转向使用 Markdown 来创建其文档了,请查看此 博文 以了解如何将 Markdown 格式的文档迁移到 [Jekyll]。如果你是为产品或服务编写文档,请试试以下的便捷工具:

Read the Docs 可以将你所开源的 Markdown 文件生成文档网站。只需将你的 GitHub 仓库连接到他们的服务,然后你就可以将内容推送到该仓库中,Read the Docs 会完成其余的工作。他们还为 商业实体提供服务。

[MkDocs] 是一个快速、简单的静态站点生成器,专门用于构建项目文档。文档源文件使用 Markdown 编写,并使用一个 YAML 配置文件进行配置。MkDocs 有多个 内置主题,包括移植自 Read the Docs 的文档主题。最新的一个主题是 MkDocs Material。

[Docusaurus] 是一个静态网站生成器,专门用于创建文档网站。它支持翻译、搜索和版本控制。

VuePress 是基于 Vue 构建的静态站点生成器,并针对编写技术文档进行了优化。

[Jekyll] 前面已经提到过它了,但它也是将 Markdown 文件生成文档网站的一个不错的选择。如果你选择 Jekyll,请务必试试 Jekyll 文档主题。

未经允许不得转载:坚果云Markdown » markdown制作文档
分享到: 更多 (0)

坚果云Markdown轻松记录您 灵感和创意

坚果云Markdown下载坚果云Markdown介绍