Docsify的使用
2023-10-06 本文已影响0人
sunsky2017
一、什么是Docsify
一个神奇的文档网站生成器。docsify 可以快速帮你生成文档网站。不同于 GitBook、Hexo 的地方是它不会生成静态的 .html 文件，所有转换工作都是在运行时。如果你想要开始使用它，只需要创建一个 index.html 就可以开始编写文档。
二、Docsify的安装（macos版）
①安装node.js - 已安装过可忽略
下载地址：https://nodejs.cn/download/
验证安装情况
- node -v：显示安装的nodejs版本
- npm -v：显示安装的npm版本
sunskys-MBP:~ xx$ node -v
v20.7.0
sunskys-MBP:~ xx$ npm -v
10.1.0
②安装docsify-cli工具
终端执行以下命令
npm i docsify-cli -g
三、Docsify的使用
①初始化
终端执行以下命令
docsify i [项目路径]
参数说明
- i也可输入全拼 init
-
项目路径不填写，默认为当前所在目录
初始化成功后，可以看到 目录下创建的几个文件
- index.html 入口文件
- README.md 会做为主页内容渲染
- .nojekyll 用于阻止 GitHub Pages 忽略掉下划线开头的文件
②本地预览
通过运行 docsify serve 启动一个本地服务器，可以方便地实时预览效果。默认访问地址 http://localhost:3000 。
docsify s [项目路径]
参数说明
- s也可输入全拼 serve
-
项目路径不填写，默认为当前所在目录
