Docsify安装与命令行参数

安装

使用npm或yarn全局安装docsify-cli。

npm i docsify-cli -g
# yarn global add docsify-cli

命令行参数

init命令

使用init来生成你的文档。

docsify init [path] [--local false] [--theme vue] [--plugins false]

# docsify i [path] [-l false] [-t vue] [--plugins false]

[path] 默认为当前目录。可以使用相对路径，如 ./docs（或 docs）。

• --local 选项：
  • 简写：-l
  • 类型：布尔值
  • 默认值：false
  • 描述：将docsify文件复制到docs路径中，默认使用cdn.jsdelivr.net作为内容传递网络（CDN）。要明确将此选项设置为false，请使用 --no-local。

• --theme 选项：
  • 简写：-t
  • 类型：字符串
  • 默认值：vue
  • 描述：选择一个主题，默认为vue，其他选择为buble、dark和pure。

• --plugins 选项：
  • 简写：-p
  • 类型：布尔值
  • 默认值：false
  • 描述：提供要作为<script>标签插入index.html的插件列表。

serve命令

在本地主机上运行带有实时刷新的服务器。

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

# docsify s [path] [-o false] [-p 3000]

• --open 选项：
  • 简写：-o
  • 类型：布尔值
  • 默认值：false
  • 描述：在默认浏览器中打开文档，默认为false。要明确将此选项设置为false，请使用 --no-open。

• • --port 选项：
  • 简写：-p
  • 类型：数字
  • 默认值：3000
  • 描述：选择一个监听端口，默认为3000。

generate命令

Docsify的生成器。

docsify generate [path] [--sidebar _sidebar.md]

# docsify g [path] [-s _sidebar.md]

• --sidebar 选项：
  • 简写：-s
  • 类型：字符串
  • 默认值：_sidebar.md
  • 描述：生成侧边栏文件，默认为_sidebar.md。