使用 Docsify 创建文档网页并发布到 GitHub Pages 上 。
? 来源：linux.cn ? 作者：Bryant Son ? 译者：Xingyu.Wang ?
（本文字数：5192 ， 阅读时长大约：6 分钟）
文档是帮助用户使用开源项目一个重要部分 ， 但它并不总是开发人员的首要任务 ， 因为他们可能更关注的是使他们的应用程序更好 ， 而不是帮助人们使用它 。 对开发者来说 ， 这就是为什么让发布文档变得更容易是如此有价值的原因 。 在本教程中 ， 我将向你展示一个这样做的方式：将 Docsify 文档生成器与 GitHub Pages 结合起来 。
默认情况下 ， GitHub Pages 会提示用户使用 Jekyll， 这是一个支持 HTML、CSS 和其它网页技术的静态网站生成器 。 Jekyll 可以从以 Markdown 格式编码的文档文件中生成一个静态网站 ， GitHub 会自动识别它们的 .md 或 .markdown 扩展名 。 虽然这种设置很好 ， 但我想尝试一下其他的东西 。
幸运的是 ， GitHub Pages 支持 HTML 文件 ， 这意味着你可以使用其他网站生成工具（比如 Docsify）在这个平台上创建一个网站 。 Docsify 是一个采用 MIT 许可证的开源项目 ， 其具有可以让你在 GitHub Pages 上轻松创建一个有吸引力的、先进的文档网站的 功能。
Docsify
开始使用 Docsify安装 Docsify 有两种方法：

1. 通过 NPM 安装 Docsify 的命令行界面（CLI） 。
2. 手动编写自己的 index.html 。

Docsify 推荐使用 NPM 方式 ， 但我将使用第二种方案 。 如果你想使用 NPM ， 请按照 快速入门指南 中的说明进行操作 。
从 GitHub 下载示例内容我已经在 该项目的 GitHub 页面 上发布了这个例子的源代码 。 你可以单独下载这些文件 ， 也可以通过以下方式 克隆这个存储库。
git clone 然后 cd 进入 DocsifyDemo 目录 。
我将在下面为你介绍这些代码 ， 它们克隆自我的示例存储库中 ， 这样你就可以理解如何修改 Docsify 。 如果你愿意 ， 你也可以从头开始创建一个新的 index.html 文件 ， 就像 Docsify 文档中的的 示例 一样：
探索 Docsify 如何工作如果你克隆了我的 GitHub 存储库， 并切换到 DocsifyDemo 目录下 ， 你应该看到这样的文件结构：
File contents in the cloned GitHub
index.html 是 Docsify 可以工作的唯一要求 。 打开该文件 ， 你可以查看其内容：
Docsify Demo

• 上一页
• 1
• 2
• 3
• 下一页

• 搜狐新闻|准大学生数码三件套如何选？这些元气好物值得种草
• 想好好做医生的胖子|五十岁女性经常有周身无力和疼痛的困扰！该如何应对？医生告诉您
• 儿童饮食|秋冬季如何让宝宝爱上吃水果？稍微蒸一下美味翻倍，营养价值更高
• 队员|北极科考中“遭遇”北极熊，看科考队员如何与它们和谐相处
• 中国历史发展过程|中国历史发展过程!中国游戏外挂发展史:“辅助工具”是如何成长为“苍
• 金色年华录|都是男扮女装谈恋爱，《少女大人》比《女世子》如何？
• 上海市嘉定区人民政府网站|每年消耗3350吨蔬菜150吨肉，嘉定这家中央厨房如何践行“光盘行动”？
• 上海嘉定|如何让《民法典》走进群众心里？嘉定这些街镇和单位这样做
• 没蜡笔的小新|“整容脸”应该被鄙视吗？医生告诉你千篇一律的好看皮囊如何而来
• 上海黄浦|“午夜快乐汇”亮相人民大舞台“星空间1号”！