Skip to content

Latest commit

 

History

History
93 lines (60 loc) · 2.16 KB

Docsify安装与配置.md

File metadata and controls

93 lines (60 loc) · 2.16 KB

Docsify安装与配置


Docsify命令行工具的安装

安装的先觉环境条件

  • NodeJS
  • NPM

安装docsify命令行工具

npm install -g docsify-cli

初始化Docsify文档库

本地新建一个文件夹作为Docsify文档库

新建完成后在新建的目录中打开CMD或其他终端工具

执行命令初始化Docsify

docsify init [options]

options为可选参数, 按需添加

参数 作用 默认值
--local, -l 是否本地化Docsify, 如果选择本地化, 则会将所有Docsify文件拷贝到当前目录, 否则只拷贝必要的文件, 所有页面需要的JS将会在访问时通过CND地址加载 false
--theme, -t 选择初始化的Docsify主题, 可选值为包括: vue, buble, dark, pure vue
--plugins, -p 初始化时是否选择启用内置插件, 添加此参数可以在初始化时选择启用内置插件 false

目录结构

以全默认参数初始化当前目录即可, 初始化完成后当前目录的文件结构如下

.
├── README.md
└── index.html

如果使用本地化参数--local初始化目录, 则初始化完成后当前目录的文件结构如下

.
├── README.md
├── index.html
└── vendor
    ├── docsify.js
    └── themes
        └── vue.css

文件说明:

  • README.md

    Docsify的首页内容markdown文件

  • index.html

    Docsify的入口页面

  • vendor

    目录下为页面需要加载的js和css文件

启动Docsify服务

使用以下命令启动本地Docsify服务

docsify serve

默认服务监听本地3000端口, 若本地3000端口已被占用, 则会自动切换到其他随机端口

docsify serve

监听启动后打开浏览器访问即可看到Docsify的首页

docsify index

?> 至此Docsify的文档库初始化就完成了, 通过编写markdown文件, 即可实现将其自动选为页面了.

Docsify配置

Docsify基本是开箱即用的, 完成上面的步骤就可以直接使用了, 配置大多是一些个性化而非功能性的

Docsify完整配置项