一个神奇的文档网站生成工具docsify
什么是docsify?
docsify官方定义是“一个神奇的文档网站生成器”
官方网站 可以查看其样式与使用教程。
- docsify本质上就是一个可以
渲染MarkDown资源的单页应用
,我们只需要写MarkDown然后挂在http服务器上就可以了。 - docsify可以快速帮你生成文档网站,我们在做完项目的时候经常会写一些项目手册,教程等。
- docsify使用
nodejs
开发,但是不必懂nodejs知识也可以搭建,使用nmp
安装。 - docsify文档格式采用
MarkDown语法
,简单就可以排版出漂亮的文档。 - docsify可直接部署在
GitHub
或者Gitee
上,实现多人合作撰写文档,需要安装Git
。
docsify使用场景有哪些?
- 项目文档/手册
- 小型博客
- 写网络书籍
docsify特点
- 不用编译,前端渲染,只占用阅读者机器的资源
- 无需构建,写完文档直接发布
- 容易使用并且轻量 (压缩后 ~21kB)
- 智能的全文搜索
- 提供多套主题
- 丰富的API
- 国际化
使用教程
使用教程这里我就不多说了,参考官方的中文文档即可,官方网站
同类型的工具
- Gitbook
- Hexo
docsify 不同于 githbook 和 hexo 它不会生成将 .md 文件化成 .html 文件,这些转化工作都是在运行时进行的
最后更新于 2021-10-05 01:03:35 并被添加「」标签,已有 746 位童鞋阅读过。
本站使用「署名 4.0 国际」创作共享协议,可自由转载、引用,但需署名作者且注明文章出处
此处评论已关闭