使用docsify搭建文档类博客系统
文章目录
1 介绍
docsify 是一个动态生成文档网站的工具,
相对于其他博客系统来说:
- docsify不会将
.md
文件转换为.html
文件,更直观 - 默认只有一个
index.html
文件,每次都是提交新的.md
文件,不会污染git commit
记录 - 只要初始化后马上就可以部署,结合GitHub Pages相当便捷
2 快速开始
关于手动初始化的方法建议直接查看官方的介绍,此处不多做说明。手动初始化
2.1安装
使用npm
进行全局安装,需要确保本地安装了node
npm install -g docsify -D
使用docsify -v
确认安装成功
docsify -v
> docsify-cli version:
4.4.1
2.2 项目初始化
## 创建一个存放项目的目录
mkdir docsify_demo ; cd docsify_demo
## 初始化项目
docsify init ./
初始化完成后可以看到文件夹中新增了文件
.
├── .nojekyll ## 用于阻止github Pages 忽略下划线开头的文件
├── index.html ## 入口文件,相关的配置也在这里书写
└── README.md 会作为主页进行渲染
2.3 开始预览
通过运行docsify serve
启动一个本地服务器,可以方便地实时预览效果。
docsify serve docs
> Listening at http://localhost:3000
到此,一个简单的框架就搭建起来了,下面就可以进行配置和写文档了。
3 配置
docsify 的配置都在index.html中
常用的一些配置
<script>
window.$docsify = {
name: 'LairLiu',
repo