阅读之前,告诉大家一个消息:本文有彩蛋
求求大家了,我的个人网站流量惨淡,来我的博客看吧:
https://redish101.github.io/2022/03/05/docsify
docsify好在哪里
开源项目的文档往往是一个很大的问题,许多静态站点生成器并不能兼顾强大与简单。
对比
Sphinx
先拿Sphinx来说吧,Sphinx因背后有python的驱动,功能十分强大,但是reStructuredText
的复杂也劝退了许多人。
Vuepress
相比之下,vuepress在文档的编写上就没有那么复杂了,毕竟markdown
还是很简单的。
But,vuepress的配置实在是太复杂了,而且构建速度及其缓慢,最重要的是需要JavaScript
的基础。
mkdocs
mkdocs可以说是能和docsify抗衡了,但是,mkdocs需要构建
使用
经过上面的的对比,docsify的优点已经很明显了,下面我们就来安装docsify
安装
全局安装Docsify-cli:
开始一个项目
配置
配置也很简单,可以参考配置项 (docsify.js.org)
写作
这个更简单,只需要在docs
文件夹里新建markdown
文件即可。
(别说你不会,送你个指南Markdown 官方教程)
路径问题
这里要注意一下路径:
假设你的目录结构如下:
那么渲染后的路径就是:
部署
Github Pages
将Github Pages的工作目录设置到docsify所在目录。
Vercel
选中docsify所在仓库,点击下面的deploy
其他
具体我也不会用,只需要记住两点:
-
无需构建
-
工作目录在根目录
参考文献
-
docsify中文文档
-
Introduction to Vercel – Vercel Docs
-
Vercel 上自动部署你的个人博客 Hugo – SegmentFault 思否
感谢阅读
彩蛋:????呵呵呵,答应你们的蛋。
教程