怎么使用Docsify和GitHub页面创建一个文档网站

这篇文章主要介绍怎么使用Docsify和GitHub页面创建一个文档网站,文中介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们一定要看完!

使用Docsify创建文档网页并发布到GitHub页面上。

文档是帮助用户使用开源项目一个重要部分,但它并不总是开发人员的首要任务,因为他们可能更关注的是使他们的应用程序更好,而不是帮助人们使用它。对开发者来说,这就是为什么让发布文档变得更容易是如此有价值的原因。在本教程中,我将向你展示一个这样做的方式:将,Docsify 文档生成器与,GitHub Pages 结合起来。

默认情况下,GitHub页面会提示用户使用,变身怪医,这是一个支持HTML, CSS和其它网页技术的静态网站生成器.Jekyll可以从以减价格式编码的文档文件中生成一个静态网站,GitHub会自动识别它们的,<代码>。海事> .markdown>

幸运的是,GitHub页面支持HTML文件,这意味着你可以使用其他网站生成工具(比如,Docsify)在这个平台上创建一个网站.Docsify是一个采用麻省理工学院许可证的开源项目,其具有可以让你在GitHub页,上轻松创建一个有吸引力的,先进的文档网站的功能。

Docsify

开始使用Docsify

安装Docsify有两种方法:

<李>

鸿蒙官方战略合作共建——HarmonyOS技术社区

<李>

通过NPM安装Docsify的命令行界面(CLI)。

<李>

手动编写自己的,<代码>索引。>

Docsify推荐使用NPM方式,但我将使用第二种方案。如果你想使用NPM,请按照快速入门指南中的说明进行操作。

从GitHub下载示例内容

我已经在该项目的GitHub页面上发布了这个例子的源代码。你可以单独下载这些文件,也可以通过以下方式克隆这个存储库。

 git  clone  https://github.com/bryantson/OpensourceDotComDemos 

然后,cd <代码> ,进入,<代码> DocsifyDemo>

我将在下面为你介绍这些代码,它们克隆自我的示例存储库中,这样你就可以理解如何修改Docsify。如果你愿意,你也可以从头开始创建一个新的,<代码> index . html代码,文件,就像Docsify文档中的的示例一样:

 & lt; !——, index.html ——祝辞,& lt; ! DOCTYPE  html> & lt; html> & lt; head>,, & lt; meta  http-equiv=癤-UA-Compatible",内容=癐E=边缘,chrome=1“祝辞,,& lt; meta  name=皏iewport",内容=翱矶?设备宽度,初始=1“祝辞,,& lt; meta  charset=癠TF-8"祝辞,,& lt; link  rel=皊tylesheet" https://www.yisu.com/zixun/, href="//cdn.jsdelivr.net/npm/docsify/themes/vue.css ">  <身体> 
 
 <脚本>窗口。$ docsify={//瓆