在开始之前,请先确保你已经满足以下两个条件:

Node.jsNode.jsGithub/Gitee

安装

docsify-cli

项目初始化

Docsify

项目目录结构

经过初始化后,可以发现项目文件夹的目录结构如下,主要有三个文件,其功能如下:

index.htmlREADME.md.nojekyllGithub Pages

本地预览

http://localhost:3000docsify
index.html

该文件中主要配置了文档网站的名字以及开启一些配置选项,比如我修改后的配置如下:

侧边栏

loadSidebar: true_sidebar.md

封面

coverpage: true_coverpage.md

主页内容

README.md

更多

如果还需要了解更多详情,可以访问官网教程[1]

GitHub Pages

新建仓库

Github Pages

提交项目

将本地的项目提交到远程;

预览

https://cunyu1943.github.io/cunyu1943
docsify

参考资料

[1]

官网教程: https://docsify.js.org/#/zh-cn/quickstart