support docsify init --plugins

README.md

@@ -1,32 +1,17 @@
-<p align="center">
-  <a href="https://docsify.js.org">
-    <img alt="docsify" src="./media/icon.svg">
-  </a>
-</p>
-
-<p align="center">
- 🖌 docsify cli - A magical documentation generator.
-</p>
-
-<p align="center">
-  <a href="#backers"><img alt="Backers on Open Collective" src="https://opencollective.com/docsify/backers/badge.svg?style=flat-square"></a>
-  <a href="#sponsors"><img alt="Sponsors on Open Collective" src="https://opencollective.com/docsify/sponsors/badge.svg?style=flat-square"></a>
-  <a href="https://travis-ci.org/docsifyjs/docsify"><img alt="Travis Status" src="https://img.shields.io/travis/docsifyjs/docsify-cli/master.svg?style=flat-square"></a>
-  <a href="https://www.npmjs.com/package/docsify"><img alt="npm" src="https://img.shields.io/npm/v/docsify-cli.svg?style=flat-square"></a>
-<a href="https://gitter.im/docsifyjs/Lobby?utm_source=share-link&utm_medium=link&utm_campaign=share-link"><img alt="gitter" src="https://img.shields.io/gitter/room/docsifyjs/docsify.svg?style=flat-square"></a>
-<a href="https://github.com/docsifyjs/docsify-cli/blob/master/LICENSE"><img alt="license" src="https://img.shields.io/github/license/docsifyjs/docsify-cli.svg?style=flat-square"></a>
-<a href="https://www.npmjs.com/package/docsify-cli"><img alt="npm-total-download" src="https://img.shields.io/npm/dt/docsify-cli.svg?style=flat-square"></a>
-<a href="https://www.npmjs.com/package/docsify-cli"><img alt="npm-monthly-download" src="https://img.shields.io/npm/dm/docsify-cli.svg?style=flat-square"></a>
-
-</p>
-
-<p align="center">Gold Sponsor via <a href="https://opencollective.com/docsify">Open Collective</a></p>
-
-<p align="center">
-  <a href="https://opencollective.com/docsify/order/3254">
-    <img src="https://opencollective.com/docsify/tiers/gold-sponsor.svg?avatarHeight=36">
-  </a>
-</p>
+# docsify-cli
+
+[![Build Status master branch](https://img.shields.io/travis/QingWei-Li/docsify-cli/master.svg?style=flat-square)](https://travis-ci.org/QingWei-Li/docsify-cli)
+[![License](https://img.shields.io/github/license/QingWei-Li/docsify-cli.svg?style=flat-square)](https://github.com/QingWei-Li/docsify-cli/blob/master/LICENSE)
+[![Github tag](https://img.shields.io/github/tag/QingWei-Li/docsify-cli.svg?style=flat-square)](https://github.com/QingWei-Li/docsify-cli/tags)
+[![npm version](https://img.shields.io/npm/v/docsify-cli.svg?style=flat-square)](https://www.npmjs.com/package/docsify-cli)
+[![npm total downloads](https://img.shields.io/npm/dt/docsify-cli.svg?style=flat-square)](https://www.npmjs.com/package/docsify-cli)
+[![npm total monthly](https://img.shields.io/npm/dm/docsify-cli.svg?style=flat-square)](https://www.npmjs.com/package/docsify-cli)
+
+> 🖌 docsify cli - A magical documentation generator.
+
+## Links
+
+* [docsify](https://github.com/QingWei-Li/docsify)
 
 ## Screencast
 
@@ -57,16 +42,21 @@ docsify init <path> [--local false] [--theme vue]
 
 `<path>` defaults to the current directory. Use relative paths like `./docs` (or `docs`).
 
-- `--local` option:
-  - Shorthand: `-l`
-  - Type: boolean
-  - Default: `false`
-  - Description: Copy `docsify` files to the docs path, defaults to `false` using `unpkg.com` as the content delivery network (CDN). To explicitly set this option to `false` use `--no-local`.
-- `--theme` option:
-  - Shorthand: `-t`
-  - Type: string
-  - Default: `vue`
-  - Description: Choose a theme, defaults to `vue`, other choices are `buble`, `dark` and `pure`.
+* `--local` option:
+  * Shorthand: `-l`
+  * Type: boolean
+  * Default: `false`
+  * Description: Copy `docsify` files to the docs path, defaults to `false` using `unpkg.com` as the content delivery network (CDN). To explicitly set this option to `false` use `--no-local`.
+* `--theme` option:
+  * Shorthand: `-t`
+  * Type: string
+  * Default: `vue`
+  * Description: Choose a theme, defaults to `vue`, other choices are `buble`, `dark` and `pure`.
+* `--plugins` option:
+  * Shorthand: `-p`
+  * Type: array
+  * Default: `[]`
+  * Description: Provide a list of plugins to insert as `<script>` tags to `index.html`. If a plugin name is provided the script will have a url of `https://unpkg.com/docsify/lib/plugins/<plugin_name>`, otherwise provide the url to the plugin. Example: `docsify init docs/ -p search gitalk https://unpkg.com/docsify-copy-code@2`
 
 ### `serve` command
 
@@ -78,21 +68,17 @@ docsify serve <path> [--open false] [--port 3000]
 # docsify s <path> [--open false] [--port 3000]
 ```
 
-- `--open` option:
-  - Shorthand: `-o`
-  - Type: boolean
-  - Default: `false`
-  - Description: Open the docs in the default browser, defaults to `false`. To explicitly set this option to `false` use `--no-open`.
-- `--port` option:
-  - Shorthand: `-p`
-  - Type: number
-  - Default: `3000`
-  - Description: Choose a listen port, defaults to `3000`.
-
-## Contributing
-
-Please see the [Contributing Guidelines](./CONTRIBUTING.md)
+* `--open` option:
+  * Shorthand: `-o`
+  * Type: boolean
+  * Default: `false`
+  * Description: Open the docs in the default browser, defaults to `false`. To explicitly set this option to `false` use `--no-open`.
+* `--port` option:
+  * Shorthand: `-p`
+  * Type: number
+  * Default: `3000`
+  * Description: Choose a listen port, defaults to `3000`.
 
 ## License
 
-[MIT](./LICENSE)
+MIT

docs/README.md

@@ -52,6 +52,11 @@ docsify init <path> [--local false] [--theme vue]
   * Type: string
   * Default: `vue`
   * Description: Choose a theme, defaults to `vue`, other choices are `buble`, `dark` and `pure`.
+* `--plugins` option:
+  * Shorthand: `-p`
+  * Type: array
+  * Default: `[]`
+  * Description: Provide a list of plugins to insert as `<script>` tags to `index.html`. If a plugin name is provided the script will have a url of `https://unpkg.com/docsify/lib/plugins/<plugin_name>`, otherwise provide the url to the plugin. Example: `docsify init docs/ -p search gitalk https://unpkg.com/docsify-copy-code@2`
 
 ### `serve` command
 

e2e/index.js

@@ -4,20 +4,27 @@ const path = require('path')
 const execa = require('execa')
 const test = require('ava')
 
-const rootCommand = path.join(process.cwd(), 'bin/docsify')
+let rootCommand = path.join(process.cwd(), 'bin/docsify')
 
 test('shows up help message without any args', async t => {
   const {stderr} = await execa(rootCommand, {reject: false})
   t.snapshot(stderr)
 })
 
 const matchSnapshot = async (t, arg) => {
-  const {stdout} = await execa(rootCommand, [arg])
+  let args = [arg]
+
+  if ((typeof arg) === 'object') {
+    args = [arg[0], ...arg.slice(1)]
+  }
+
+  const {stdout} = await execa(rootCommand, args)
   t.snapshot(stdout)
 }
 
 test('shows help with -h flag', matchSnapshot, '-h')
 test('shows help with --help flag', matchSnapshot, '--help')
+test('shows help with init --help flag', matchSnapshot, ['init', '--help'])
 test('shows version information with -v flag', matchSnapshot, '-v')
 test('shows version information with --version flag', matchSnapshot, '--version')
 

e2e/index.js.md

@@ -4,7 +4,7 @@ The actual snapshot is saved in `index.js.snap`.
 
 Generated by [AVA](https://ava.li).
 
-## shows help with --help flag
+## rejects promise due to error on passing in an unknown command
 
 > Snapshot 1
 
@@ -24,9 +24,11 @@ Generated by [AVA](https://ava.li).
       https://docsifyjs.github.io/docsify-cli␊
     ␊
     Development:␊
-      https://github.com/docsifyjs/docsify-cli/blob/master/CONTRIBUTING.md`
+      https://github.com/docsifyjs/docsify-cli/blob/master/CONTRIBUTING.md␊
+    ␊
+    Unknown argument: junkcmd`
 
-## shows help with -h flag
+## shows help with --help flag
 
 > Snapshot 1
 
@@ -48,7 +50,7 @@ Generated by [AVA](https://ava.li).
     Development:␊
       https://github.com/docsifyjs/docsify-cli/blob/master/CONTRIBUTING.md`
 
-## shows up help message without any args
+## shows help with -h flag
 
 > Snapshot 1
 
@@ -68,29 +70,28 @@ Generated by [AVA](https://ava.li).
       https://docsifyjs.github.io/docsify-cli␊
     ␊
     Development:␊
-      https://github.com/docsifyjs/docsify-cli/blob/master/CONTRIBUTING.md␊
-    ␊
-    [ERROR] 0 arguments passed. Please specify a command`
-
-## shows version information with --version flag
-
-> Snapshot 1
-
-    `␊
-    docsify-cli version:␊
-      4.4.0␊
-    `
+      https://github.com/docsifyjs/docsify-cli/blob/master/CONTRIBUTING.md`
 
-## shows version information with -v flag
+## shows help with init --help flag
 
 > Snapshot 1
 
-    `␊
-    docsify-cli version:␊
-      4.4.0␊
-    `
+    `docsify init [path]␊
+    ␊
+    Creates new docs␊
+    ␊
+    Global Options␊
+      --help, -h     Show help                                             [boolean]␊
+      --version, -v  Show version number                                   [boolean]␊
+    ␊
+    Options:␊
+      --local, -l    Copy docsify files to local. To explicitly set --local to false␊
+                     you may use --no-local.              [boolean] [default: false]␊
+      --theme, -t    Theme file to be used.␊
+                 [string] [choices: "vue", "buble", "dark", "pure"] [default: "vue"]␊
+      --plugins, -p  A list of plugins to be used.                           [array]`
 
-## rejects promise due to error on passing in an unknown command
+## shows up help message without any args
 
 > Snapshot 1
 
@@ -112,4 +113,22 @@ Generated by [AVA](https://ava.li).
     Development:␊
       https://github.com/docsifyjs/docsify-cli/blob/master/CONTRIBUTING.md␊
     ␊
-    Unknown argument: junkcmd`
+    [ERROR] 0 arguments passed. Please specify a command`
+
+## shows version information with --version flag
+
+> Snapshot 1
+
+    `␊
+    docsify-cli version:␊
+      4.4.0␊
+    `
+
+## shows version information with -v flag
+
+> Snapshot 1
+
+    `␊
+    docsify-cli version:␊
+      4.4.0␊
+    `

lib/cli.js

@@ -41,9 +41,14 @@ require('yargs')
           nargs: 1,
           requiresArg: true,
           type: 'string'
+        },
+        plugins: {
+          alias: 'p',
+          desc: chalk.gray(y18n.__('init.plugins')),
+          type: 'array'
         }
       }),
-    handler: argv => run.init(argv.path, argv.local, argv.theme)
+    handler: argv => run.init(argv.path, argv.local, argv.theme, argv.plugins)
   })
   .command({
     command: 'serve [path]',

lib/commands/init.js

@@ -10,7 +10,7 @@ const replace = function (file, tpl, replace) {
 }
 
 // eslint-disable-next-line
-module.exports = function (path = '', local, theme) {
+module.exports = function (path = '', local, theme, plugins) {
   const msg =
     '\n' +
     chalk.green('Initialization succeeded!') +
@@ -64,5 +64,16 @@ module.exports = function (path = '', local, theme) {
     replace(target(filename), 'repo: \'\'', `repo: '${repo}'`)
   }
 
+  if (plugins) {
+    replace(target(filename), '_plugins_', '_plugin\n  '.repeat(plugins.length))
+    plugins.forEach(plugin => {
+      const url = plugin.includes('//') ? plugin : `https://unpkg.com/docsify/lib/plugins/${plugin}.min.js`
+      const scriptTemplate = `<script src="${url}"></script>`
+      replace(target(filename), '_plugin', scriptTemplate)
+    })
+  } else {
+    replace(target(filename), '_plugins_', '')
+  }
+
   console.log(msg)
 }

lib/template/index.html

@@ -17,5 +17,6 @@
     }
   </script>
   <script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
+  _plugins_
 </body>
 </html>

tools/locales/en.json

@@ -6,6 +6,7 @@
   "start": "Server for SSR",
   "init.local": "Copy docsify files to local. To explicitly set --local to false you may use --no-local.",
   "init.theme": "Theme file to be used.",
+  "init.plugins": "A list of plugins to be used.",
   "serve": "Run local server to preview site.",
   "serve.open": "Open docs in default browser. To explicitly set --open to false you may use --no-open.",
   "serve.port": "Listen port.",