返回

从0搭建属于自己的文档站点，邀请世界来评论

闲谈

  1. 准备工作

在搭建开始之前，我们需要完成一些准备工作，首先便是注册一个github账号，没有账号的可以通过访问github官网进行注册。一般而言，用户在创建项目之前，需要先对自己的代码库进行设置。

创建一个仓库，点击右上角的“+”，选择“New repository”， 输入项目名称，此处取名为docsify，description处输入项目的，最后点击“Create repository”即可。

此时一个新的代码仓库就创建好了，你可以点击“Code”按钮看到仓库中存在 README.md 文件，你也可以点击左上角的菜单栏，在“Actions”中创建一个workflow。workflow是一个CI/CD工具，可以对项目进行自动化构建，测试，部署等。

1. 安装docsify-cli

在准备工作完成后，我们需要先对docsify-cli进行安装。docsify-cli是docsify的命令行工具，提供了丰富的命令用于对docsify项目的初始化和构建。

使用如下命令进行安装：

npm install -g docsify-cli

安装完成后，你可以通过如下命令查看已安装的docsify-cli版本：

docsify-cli -v

2. 本地搭建

docsify-cli提供了docsify init命令来初始化一个新的docsify项目。使用如下命令即可：

docsify init hexo-docsify

命令执行后，会在当前目录创建一个名为hexo-docsify的文件夹，该文件夹中包含了一个完整的docsify项目，包括文档、样式、脚本等。

3. 发布至github

使用docsify-cli提供了docsify-deploy命令将项目发布至github page，执行如下命令：

docsify-deploy --github hexo-docsify

命令执行后，将会在github page上生成一个新的站点，站点地址为：

https://{username}.github.io/{repository}

4. 实现评论功能

docsify支持使用disqus、utterances、gitalk等评论系统，这里我们选择使用utterances，该系统无需配置即可使用。

首先，在utterances官网创建一个新的项目，并获取项目ID和项目名称，然后在hexo-docsify项目的index.html文件中添加如下代码：

<!--utterances代码-->

其中，utterances-article-url属性指定了评论页面的URL，utterances-issue-term属性指定了评论页面中的issue术语。

保存文件后，重新构建项目并将其发布到github page，此时评论功能即可使用。

总结

本文介绍了如何在github pages上搭建自己的文档站点，并实现评论功能。希望本文对您有所帮助。