diff --git a/docs/README.md b/docs/README.md index 599a815..4af7ae5 100644 --- a/docs/README.md +++ b/docs/README.md @@ -13,6 +13,11 @@ * [docsify](https://github.com/docsifyjs/docsify) +## language + +* [English](#/) +* [Japanese](jp/) + ## Screencast ![Screencast](https://raw.githubusercontent.com/docsifyjs/docsify-cli/master/media/screencast.gif) diff --git a/docs/jp/README.md b/docs/jp/README.md new file mode 100644 index 0000000..69c27cc --- /dev/null +++ b/docs/jp/README.md @@ -0,0 +1,83 @@ +# docsify-cli + +[![Build Status master branch](https://github.com/docsifyjs/docsify-cli/workflows/docsify-cli/badge.svg)](https://github.com/docsifyjs/docsify-cli/actions) +[![License](https://img.shields.io/github/license/docsifyjs/docsify-cli.svg?style=flat-square)](https://github.com/docsifyjs/docsify-cli/blob/master/LICENSE) +[![Github tag](https://img.shields.io/github/tag/docsifyjs/docsify-cli.svg?style=flat-square)](https://github.com/docsifyjs/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 - 魔法のドキュメントジェネレーター。 + +## リンク + +* [docsify](https://github.com/docsifyjs/docsify) + +## スクリーンショット + +![Screencast](https://raw.githubusercontent.com/docsifyjs/docsify-cli/master/media/screencast.gif) + +> live-reloadを使用して `localhost` 上にサーバーを起動しています。 + +## インストール + +`docsify-cli`を`npm`か`yarn`を経由して、グローバルにインストールします。 + +```shell +npm i docsify-cli -g +# yarn global add docsify-cli +``` + +## 使い方 + +### `init` コマンド + +`init` を使ってあなたのドキュメントを作成します。 + +```shell +docsify init [--local false] [--theme vue] [--plugins false] + +# docsify i [--local false] [--theme vue] [--plugins false] +``` + +`` のデフォルトではカレントディレクトリ（現在のディレクトリ）です。`./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 + * デフォルト: `[]` + * 説明: ` + + +