support docsify init --plugins

README.md

@@ -1,98 +0,0 @@
-<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>
-
-## Screencast
-
-![Screencast](https://raw.githubusercontent.com/QingWei-Li/docsify-cli/master/media/screencast.gif)
-
-> Running a server on `localhost` with live-reload.
-
-## Installation
-
-Install `docsify-cli` via `npm` or `yarn` globally.
-
-```shell
-npm i docsify-cli -g
-# yarn global add docsify-cli
-```
-
-## Usage
-
-### `init` command
-
-Use `init` to generate your docs.
-
-```shell
-docsify init <path> [--local false] [--theme vue]
-
-# docsify i <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`.
-
-### `serve` command
-
-Run a server on `localhost` with livereload.
-
-```shell
-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)
-
-## License
-
-[MIT](./LICENSE)

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
 

index.html

@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Document</title>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+  <meta name="description" content="Description">
+  <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/lib/themes/vue.css">
+</head>
+<body>
+  <div id="app"></div>
+  <script>
+    window.$docsify = {
+      name: '',
+      repo: ''
+    }
+  </script>
+  <script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
+</body>
+</html>

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.",