个人docsify在线文档搭建
最初是想用gitbook做在线文档的,但是其node.js版本限制,带给我的体验感并不是很好(每次想安装一些包或者本地启动项目都要先切换到node低版本🤔)。
一、创建docsify项目
1、前期准备
npm i docsify-cli -g
2、创建项目
# 初始化项目,并进入项目文件夹
docsify init ./PersonDocs
code ./PersonDocs
# 本地预览
docsify serve
二、docsify项目配置
1、侧边栏
- _sidebar.md
其作用类似于gitbook中的SUMMARY.md
- [首页](README)
- [第一章](part1/README.md)
- [1.1 第一节](part1/writing.md)
- [1.2 第二节](part1/gitbook.md)
- [第二章](part2/README.md)
- [2.1 第一节](part2/feedback_please.md)
- [2.2 第二节](part2/better_tools.md)
- index.html
window.$docsify = {
loadSidebar: true,
subMaxLevel: 2,
};
2、封面
- _coverpage.md
<!-- _coverpage.md -->
![logo](_media/icon.svg)
# docsify
> 一个神奇的文档网站生成器。
[GitHub](https://github.com/docsifyjs/docsify/)
[Get Started](README.md)
<!-- 背景图片 -->
![](_media/bg.jpg)
<!-- 背景色 -->
![color](#232830)
使用背景图片,还是背景色,二选一
- index.html
window.$docsify = {
coverpage: true,
onlyCover: true,
};
三、部署
1、方式1
在对应的 Gitee 仓库服务中选择 Gitee Pages,选择您要部署的分支,填写您要部署的分支上的目录,例如docs,填写完成之后点击启动即可。
2、方式2
使用vercel + github自动部署,比较简单,不做过多介绍。