加載中...
Docsify个人网站搭建教程(1)
發表於:2023-01-11 | 分類: 教程
字數統計: 926 | 閱讀時長: 3分鐘 | 閱讀量:

# 什么是 Docsify

docsify 是一个有魔法的文档网站生成器,它能够动态生成您的文档网站。与 GitBook、Hexo 不同,它不生成静态 html 文件,而是智能地加载和解析您的 md 文件,并将其显示为网站。要开始使用它,只需创建一个 index.html 并将其部署在 GitHub Page/Gitee Page 等第三方站点上即可。

官网:docsify

特点:

无需构建静态的 html 文件
轻量
拥有智能的全文搜索插件
支持多主题
支持丰富的 API 插件
支持表情符号
兼容 IE11
支持服务端的渲染

# 安装 Docsify

安装 docsify 之前,我们需要安装 npm 包管理器,而安装了 node.js 就会自动安装 npm,对于 node.js,直接去 Node.js 官网选择合适的版本进行下载,然后一键安装即可。
接下来我们检查是否安装完成 nodejs:

1
npm -v

接着我们来全局安装 docsify-cli,这是一个 docsify 的命令行工具,可以帮助我们在本地进行 docsify 的初始化和网站的预览。

1
npm i docsify-cli -g

然后我们创建一个文件夹,用来存储 docsify 所有的文件,接着输入以下命令进行初始化

1
2
mkdir docsify
docsify init ./docsify

初始化

可以看到初始化成功了,我们就可以在刚创建的 Docsify 文件夹中查看到 README.md 和 index.html 两个文件,此外还存在一个隐藏文件.nojekyll

1
2
3
4
5
6
zhongsiru@zhongsirudeAir Documents % cd Docsify 
zhongsiru@zhongsirudeAir Docsify % tree
.
├── README.md # 会做为主页内容渲染
└── index.html # 入口文件
└── .nojekyll # 用于阻止 GitHub Pages 忽略掉下划线开头的文件

根据上述提示命令,我们便可启动 docsify 的网站,默认在本地的 3000 端口

我们访问该网址,便可以看到内容

这里渲染的内容就是上述 Docsify 文件夹中的 README.md,我们如果更改该文件中的内容,网站的内容会自动同步更新。

# 多页文档配置

我们可以轻松的在 docsify 实现多级路由的网站,比如在前面创建的 Docsify 文件夹中创建 guide.md、zh-cn/READEME.md、zh-cn/guide.md,结构如下所示:

1
2
3
4
5
6
7
 .
├── README.md
├── guide.md
├── index.html
└── zh-cn
├── README.md
└── guide.md

此时我们访问如下 url 即可以访问到对应的页面:

1
2
3
4
README.md					=> http://localhost:3000/#/
guide.md => http://localhost:3000/#/guide
/zh-cn/README.md => http://localhost:3000/#/zh-cn/
/zh-cn/guide.md => http://localhost:3000/#/zh-cn/guide

# 定制化配置

侧边栏
默认情况下,我们的侧边栏是根据 Markdown 文件自动生成,我们也可以定制化进行设定,首先修改 Docsdify/index.html 开启侧边栏的选项添加 loadSiderbar: true,这样设置后就会加载 Docsify 目录下的 _sidebar.md 文件进行加载而渲染成我们定制的侧边栏。

1
2
3
4
5
6
7
8
<script>
window.$docsify = {
name: '',
repo: '',
// 开启侧边栏定制,加载_sidebar.md
loadSidebar: true,
}
</script>

然后我们在 Docsify 目录下创建一个 _sidebar.md 文件,里面可以对侧边栏进行配置,比如这里配置如下:

1
2
3
4
5
6
<!-- Docsify/_sidebar.md -->

* [首页](/)
* [guide](/guide)
* [zh-cn](zh-cn/)
* [zh-cn guide](zh-cn/guide)

也就是 MarkDown 中的超链接语法,后面的路径也就对应着上述多页文档的路由路径

这样设置以后,渲染出的侧边栏如下图所示,我们点击对应地方即可跳转到对应的多页文档

此外我们还可以指定页面的标题,比如这里指定首页的标题为 home

1
2
3
4
5
6
<!-- Docsify/_sidebar.md -->

* [首页](/ "home")
* [guide](/guide)
* [zh-cn](zh-cn/)
* [zh-cn guide](zh-cn/guide)

上壹篇:
Docsify个人网站搭建教程(2)
下壹篇:
写一个好看的404html界面