-
-
Notifications
You must be signed in to change notification settings - Fork 159
Add a japanese document #155
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
83 changes: 83 additions & 0 deletions
docs/jp/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| # docsify-cli | ||
|
|
||
| [](https://github.com/docsifyjs/docsify-cli/actions) | ||
| [](https://github.com/docsifyjs/docsify-cli/blob/master/LICENSE) | ||
| [](https://github.com/docsifyjs/docsify-cli/tags) | ||
| [](https://www.npmjs.com/package/docsify-cli) | ||
| [](https://www.npmjs.com/package/docsify-cli) | ||
| [](https://www.npmjs.com/package/docsify-cli) | ||
|
|
||
| > 🖌 docsify cli - 魔法のドキュメントジェネレーター。 | ||
|
|
||
| ## リンク | ||
|
|
||
| * [docsify](https://github.com/docsifyjs/docsify) | ||
|
|
||
| ## スクリーンショット | ||
|
|
||
|  | ||
|
|
||
| > live-reloadを使用して `localhost` 上にサーバーを起動しています。 | ||
|
|
||
| ## インストール | ||
|
|
||
| `docsify-cli`を`npm`か`yarn`を経由して、グローバルにインストールします。 | ||
|
|
||
| ```shell | ||
| npm i docsify-cli -g | ||
| # yarn global add docsify-cli | ||
| ``` | ||
|
|
||
| ## 使い方 | ||
|
|
||
| ### `init` コマンド | ||
|
|
||
| `init` を使ってあなたのドキュメントを作成します。 | ||
|
|
||
| ```shell | ||
| 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`に挿入するプラグインのリストを提供します。 | ||
|
|
||
| ### `serve` コマンド | ||
| livereloadを使用して、`localhost`にサーバーを起動します。 | ||
|
|
||
| ```shell | ||
| 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 |
22 changes: 22 additions & 0 deletions
docs/jp/index.html
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <head> | ||
| <meta charset="UTF-8"> | ||
| <title>docsify-cli - A magical documentation generator.</title> | ||
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" /> | ||
| <meta name="description" content="A magical documentation generator."> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"> | ||
| <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/themes/vue.css"> | ||
| </head> | ||
| <body> | ||
| <div id="app"></div> | ||
| <script> | ||
| window.$docsify = { | ||
| name: 'docsify-cli', | ||
| basePath: '/docsify-cli/', | ||
| repo: 'docsifyjs/docsify-cli' | ||
| } | ||
| </script> | ||
| <script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script> | ||
| </body> | ||
| </html> |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.