有的时候我们想为自己的项目写一个美观好看的文档,又或者是我们想整理自己所学习的知识,但是市面上的各种文档程序,很多都是安装繁琐配置麻烦,而我们又不想把文档放在第三方的服务上,那么我们就可以使用docsify来作为我们的文档生成器,只是因为它很简单,我们只需要创建一个html文件,就可以直接开始使用markdown写文档了。
介绍
docsify 可以快速帮你生成文档网站。不同于 GitBook、Hexo 的地方是它不会生成静态的 .html
文件,所有转换工作都是在运行时。如果你想要开始使用它,只需要创建一个 index.html
就可以开始编写文档并直接部署在 GitHub Pages。
来自官方文档https://docsify.js.org/#/zh-cn/
安装
官方推荐使用cli工具来安装,可以实时预览,如果我们不会使用cli,那么我们可以直接使用手动安装的方式,也是非常的简单的。
首先,我们创建一个文件夹docs
在此文件夹下创建index.html文件,使用文本编辑器将下方内容复制进去
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta charset="UTF-8">
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/themes/vue.css">
</head>
<body>
<div id="app"></div>
<script>
window.$docsify = {
//...
}
</script>
<script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
</body>
</html>
写作
在同级目录创建README.md文件,需要写的内容直接在此文件中使用markdown编辑即可。这里推荐使用VScode+ LiveServer插件,可以实时预览修改之后的内容
更多功能
请访问官方文档:https://docsify.js.org/#/zh-cn/
看着这个好像很厉害的样子哈。
这个和个人喜好有关啦
好吧
看起来值得一试
hugo生成也比较方便OωO
hugo也需要配置环境吧,这个不需要
那倒是很方便哦