如何使用docsify和GitHub页面创建文档网站？

如何自己创建网站

？文档是帮助用户使用开源项目的一个重要部分，但它并不总是开发人员的首要任务，因为他们可能更关心如何使他们的应用程序更好地使用它。这就是为什么开发人员可以更容易地发布文档。在本教程中，我将向您展示一种方法：如何自己创建网站。

如何使用docsify和GitHub页面创建文档网站？

默认情况下，githubpages会提示用户使用Jekyll，一个支持HTML、CSS和其他web技术的静态网站生成器。Jekyll可以从以降价格式编码的文档文件生成一个静态网站，GitHub将自动识别它们。MD或。降价扩展。这是一个很好的设置，但我想试试别的。

幸运的是，githubpages支持HTML文件，这意味着您可以使用docsify等其他站点生成工具在这个平台上创建一个网站。Docsify是一个拥有MIT许可证的开源项目，它可以很容易地在githubpages上创建一个有吸引力的***文档网站。

文件

安装docsify有两种方法：

Docsify推荐NPM，但我将使用第二个选项。如果要使用NPM，请按照快速入门指南中的说明进行操作。

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

然后CD进入docsifydemo目录。

如果您克隆我的GitHub存储库并切换到docsifydemo目录，您应该会看到以下文件结构：

文件内容包含在ClonedWithub中

这基本上只是一个普通的HTML文件，但是看看这两行：

这些行使用内容交付网络（CDN）的URL来提供CSS和JavaScript脚本来将站点转换为docsify站点。只要包含这些行，就可以将常规GitHub页面转换为文档页面。

body标记后的***行指定要呈现的内容：

Docsify使用单页应用程序（SPA）呈现请求的页面，而不是刷新新页面。

***，查看脚本块中的行：

在此区块中：

您可以在docsify文档的配置部分找到所有选项。

它使用markdown的链接格式来创建导航。请注意，tomcat、cloud和Java等链接是缩进的；这意味着它们在父链接下呈现为子链接。

图像自述文件.md像和图像这样的文件与存储库的结构有关，但所有其他的降价文件都与docsify网页相关。

根据您的需要，请随意修改您下载的文件。接下来，将这些文件添加到GitHub存储库中，启用githubpages，并完成项目。

创建示例GitHub存储库，并使用以下GitHub命令签出、提交和推送代码：

设置githubpages页面。在新的GitHub存储库中，单击“设置”：

设置链接到Sub

向下滚动直到看到githubpages：

GithubPages设置

“查找”部分：

GithubPages设置

单击“源”下的下拉菜单。通常，您会将其设置为“主分支”，但如果您愿意，也可以使用其他分支：

设置SourceToMasterBranch

就这样！现在应该有一个链接到githubpages的页面。单击此链接将带您到那里，然后使用docsify呈现它：

链接到SubpagesDocssite

应该是这样的：

示例Docsifysiteongitubpage

如何自己创建网站？通过编辑HTML文件和一些降价文本，您可以使用docsify创建一个外观漂亮的文档网站。你觉得怎么样？请留言并分享其他可以与githubpages一起使用的开源工具。