docsify命令行操作

目录

• docsify-cli
  • 在线文档地址
  • 简介
  • 安装
  • init生成文档
  • serve命令
  • generate命令

docsify-cli

在线文档地址

官网文档

npm使用说明

简介

一个神奇的文档生成器。

安装

npm i docsify-cli -g

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到文档路径，默认值是false用来使用cdn.jsdelivr.net<内容分发网络（CDN）>。要显式设置此选项以使用--no-local。

--theme选项：

• 速记：-t

• 类型：字符串

• 默认：vue

• 说明：选择一个主题，默认为vue，其他选项为buble，dark和pure。

--plugins选项：

• 速记：-p
• 类型：布尔值
• 默认：false
• 描述：提供插件列表作为<script>标签插入到index.html.

serve命令

localhost使用 livereload运行服务器。

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.