使用docsify快速搭建markdown网站

作者：langdi 来源：ytt 发布时间：2022-11-12 11:32:21

---

1 简介

docsify 可以快速帮你生成文档网站。不同于 GitBook、Hexo 的地方是它不会生成静态的 .html 文件，所有转换工作都是在运行时。如果你想要开始使用它，只需要创建一个 index.html 就可以开始编写文档并直接部署。

2 安装步骤

2.1 确保电脑已经安装node.js环境

2.2安装docsify-cli工具

推荐全局安装 docsify-cli 工具，可以方便地创建及在本地预览生成的文档

npm i docsify-cli -g

2.3 进入网站想部署的文件目录 初始化项目

docsify init .

初始化成功后，可以看到 . 目录下创建的几个文件

index.html 入口文件

README.md 会做为主页内容渲染

.nojekyll 用于阻止 GitHub Pages 忽略掉下划线开头的文件

2.4 本地预览

docsify serve .

便可启动本地服务器

2.5 编辑markdown文本

只需要使用自己喜欢的编辑器打开根目录的README.md。编辑完后保存，在启动的服务器就可实时预览修改状况。

2.6 如果要想支持数学公式 可配置如下

在head部分添加

<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/katex@latest/dist/katex.min.css" />

在body部分添加

<script src="//cdn.jsdelivr.net/npm/katex@latest/dist/katex.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/marked@4"></script>
<script src="//cdn.jsdelivr.net/npm/docsify-katex@latest/dist/docsify-katex.js"></script>