官方文档

一、安装

cmd执行命令

# 推荐全局安装 docsify-cli 工具，可以方便地创建及在本地预览生成的文档。
npm i docsify-cli -g

初始化项目，如果想在项目的 ./docs 目录里写文档，直接通过 init 初始化项目。

# 可在任意项目或目录下执行初始化操作
docsify init ./docs
# 如果提示 docsify : 无法将“docsify”项识别为 cmdlet…… 的报错信息，则改为如下命令
npx docsify init ./docs

本地预览

# docsify serve 启动一个本地服务器
docsify serve docs
# 如果提示 docsify : 无法将“docsify”项识别为 cmdlet…… 的报错信息，则改为如下命令
npx docsify serve docs

更多命令行参照https://github.com/docsifyjs/docsify-cli文档，下面是几个常用例子

# docsify serve [path] [--open false] [--port 3000]

# 使用3001端口启动
docsify serve docs --port 3001
# 使用3001端口启动（短命令方式）
docsify serve docs -p 3001

# 使用后台静默模式启动，运行命令时在末尾添加符号 &
docsify serve docs &

# 静默模式下，使用如下命令，查找服务，杀死端口，可以停止服务
ps -ef|grep docsify
kill 端口号

浏览器访问

二、linux宝塔安装注意事项

1、由于宝塔中可以安装多个版本的nodejs，所以想用node命令，需要指定一个node版本

2、npm操作 npm i docsify-cli -g 时候，如果卡住了，检查下镜像源有没有正确配置成国内地址

# 设置npm镜像源
npm config set registry https://registry.npmmirror.com
# 检查镜像源配置情况
npm config get registry

3、如果执行 docsify init ./docs 提示，找不到docsify命令，可以使用安装的模块绝对路径执行命令，案例如下

# 使用绝对路径命令查看docsify版本
/www/server/nodejs/v16.14.0/bin/docsify -v
# 使用绝对路径命令初始化docs文件夹
/www/server/nodejs/v16.14.0/bin/docsify init ./docs