docsify-cli

🖌 docsify cli - 魔法のドキュメントジェネレーター。

リンク

live-reloadを使用して localhost 上にサーバーを起動しています。

docsify-cliをnpmかyarnを経由して、グローバルにインストールします。

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

init を使ってあなたのドキュメントを作成します。

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

# docsify i <path> [--local false] [--theme vue] [--plugins false]

<path> のデフォルトではカレントディレクトリ（現在のディレクトリ）です。./docs (または docs)などの相対パスを使用します。

--local オプション:
- 省略: -l
- タイプ: boolean
- デフォルト: false
- 説明: docsify ファイルをドキュメントのパスにコピーします。unpkg.comをcontent delivery network (CDN)として使用するとデフォルトではfalseになります。このオプションを明示的に false に設定するためには、 --no-local を使用します。
--theme オプション:
- 省略: -t
- タイプ: string
- デフォルト: vue
- 説明: テーマを選択します。デフォルトは vueです。ほかの選択肢は bubleと dark と pureです。
--plugins オプション:
- 省略: -p
- タイプ: array
- デフォルト: []
- 説明: <script> タグとして index.htmlに挿入するプラグインのリストを提供します。

livereloadを使用して、localhostにサーバーを起動します。

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

# docsify s <path> [--open false] [--port 3000]

--open option:
- 省略: -o
- タイプ: boolean
- デフォルト: false
- 説明: ドキュメントをデフォルトのブラウザーで開きます。デフォルトでは false　です。このオプションを明示的にfalseに設定するために --no-openを使用します。
--port option:
- 省略: -p
- タイプ: number
- デフォルト: 3000
- 説明: 待ち受けポートを選択します。デフォルトでは　3000　です。

MIT