Hello 2020 使用开源文档工具docsify

Hello docsify, Hello 开源文档

Posted by WuQingBao on September 19, 2020

使用开源文档工具docsify,用写博客的姿势写文档

下面的简介摘抄自docsify的官网 https://docsify.js.org 中的简介

docsify是一个神奇的文档网站生成器。他可以快速帮你生成文档网站。不同于GitBookHexo的地方是它不会生成静态的.html文件,所有转换工作都是在运行时。如果你想要开始使用他,只需要创建一个index.html就可以开始编写文档并直接部署在GitHub Pages(码云Pages、阿某云OSS或者鹅云COS等等)。它的主要特性如下:

  • 无需构建,写完文档直接发布(运行时markdown文档转换)
  • 容易使用并且轻量(压缩后 ~21kB,当然这里不包括markdown文档的大小)
  • 智能的全文搜索
  • 丰富的API
  • 支持Emoji,可以在文中添加表情
  • 兼容IE11
  • 支持服务端渲染SSR

docsify的最大优势是可以让使用者感受到用写博客的姿势去编写文档,反过来说也行:用写文档的姿势去写博客docsify的学习成本很低,部署简单,官方文档十分完善,原则上只需要理解markdown的语法和Node.js的安装即可,对于非IT技术从业者也十分友好。知名的技术公众号号主JavaGuide的站点就是采用docsify构建的。下文简单介绍docsify的使用姿势。

安装docsify和初始化项目#

docsify是一个Node.js插件,所以需要提前安装Node.js。安装完毕后,通过下面命令全局安装docsify

1
npm i docsify-cli -g

假设磁盘中有一个/docsify-demo目录,在该目录下可以直接通过docsify init命令初始化项目:

1
2
# 先进入docsify-sample目录,在docsify-sample目录打开命令行
docsify init

https://www.cnblogs.com/throwable/p/13605289.html#%E5%B0%8F%E7%BB%93