From 4b5d3dc6dd248897b46cafd765c6be18cbc59e77 Mon Sep 17 00:00:00 2001 From: rihitosan <76610702+rihitosan@users.noreply.github.com> Date: 2021年9月25日 10:28:45 +0900 Subject: [PATCH 1/4] Add files via upload --- docs/jp/README.md | 84 ++++++++++++++++++++++++++++++++++++++++++++++ docs/jp/index.html | 22 ++++++++++++ 2 files changed, 106 insertions(+) create mode 100644 docs/jp/README.md create mode 100644 docs/jp/index.html diff --git a/docs/jp/README.md b/docs/jp/README.md new file mode 100644 index 0000000..599a815 --- /dev/null +++ b/docs/jp/README.md @@ -0,0 +1,84 @@ +# 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 - A magical documentation generator. + +## Links + +* [docsify](https://github.com/docsifyjs/docsify) + +## Screencast + +![Screencast](https://raw.githubusercontent.com/docsifyjs/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 [--local false] [--theme vue] [--plugins false] + +# docsify i [--local false] [--theme vue] [--plugins false] +``` + +`` 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`. +* `--plugins` option: + * Shorthand: `-p` + * Type: array + * Default: `[]` + * Description: Provide a list of plugins to insert as ` + +

AltStyle によって変換されたページ (->オリジナル) /

+ From 80875b428ab159367e22d408bada074db2d329e0 Mon Sep 17 00:00:00 2001 From: rihitosan <76610702+rihitosan@users.noreply.github.com> Date: 2021年9月25日 12:26:14 +0900 Subject: [PATCH 2/4] Update README.md --- docs/jp/README.md | 77 +++++++++++++++++++++++------------------------ 1 file changed, 38 insertions(+), 39 deletions(-) diff --git a/docs/jp/README.md b/docs/jp/README.md index 599a815..69c27cc 100644 --- a/docs/jp/README.md +++ b/docs/jp/README.md @@ -7,32 +7,32 @@ [![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. +> 🖌 docsify cli - 魔法のドキュメントジェネレーター。 -## Links +## リンク * [docsify](https://github.com/docsifyjs/docsify) -## Screencast +## スクリーンショット ![Screencast](https://raw.githubusercontent.com/docsifyjs/docsify-cli/master/media/screencast.gif) -> Running a server on `localhost` with live-reload. +> live-reloadを使用して `localhost` 上にサーバーを起動しています。 -## Installation +## インストール -Install `docsify-cli` via `npm` or `yarn` globally. +`docsify-cli`を`npm`か`yarn`を経由して、グローバルにインストールします。 ```shell npm i docsify-cli -g # yarn global add docsify-cli ``` -## Usage +## 使い方 -### `init` command +### `init` コマンド -Use `init` to generate your docs. +`init` を使ってあなたのドキュメントを作成します。 ```shell docsify init [--local false] [--theme vue] [--plugins false] @@ -40,27 +40,26 @@ docsify init [--local false] [--theme vue] [--plugins false] # docsify i [--local false] [--theme vue] [--plugins false] ``` -`` 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`. -* `--plugins` option: - * Shorthand: `-p` - * Type: array - * Default: `[]` - * Description: Provide a list of plugins to insert as `>` tags to `index.html`. - -### `serve` command - -Run a server on `localhost` with livereload. +`` のデフォルトではカレントディレクトリ(現在のディレクトリ)です。`./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 + * デフォルト: `[]` + * 説明: `>` タグとして `index.html`に挿入するプラグインのリストを提供します。 + +### `serve` コマンド +livereloadを使用して、`localhost`にサーバーを起動します。 ```shell docsify serve [--open false] [--port 3000] @@ -69,16 +68,16 @@ docsify serve [--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`. + * 省略: `-o` + * タイプ: boolean + * デフォルト: `false` + * 説明: ドキュメントをデフォルトのブラウザーで開きます。デフォルトでは `false` です。 このオプションを明示的に`false`に設定するために `--no-open`を使用します。 * `--port` option: - * Shorthand: `-p` - * Type: number - * Default: `3000` - * Description: Choose a listen port, defaults to `3000`. + * 省略: `-p` + * タイプ: number + * デフォルト: `3000` + * 説明: 待ち受けポートを選択します。 デフォルトでは `3000` です。 -## License +## ライセンス MIT From 7b087ca61b8d504bf778bb20a25c7101b831063a Mon Sep 17 00:00:00 2001 From: rihitosan <76610702+rihitosan@users.noreply.github.com> Date: 2021年9月25日 12:29:06 +0900 Subject: [PATCH 3/4] Update README.md --- docs/README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/README.md b/docs/README.md index 599a815..c5c30f7 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) From 1d28d772904a426453e3a7e2e8d988d8a801d38f Mon Sep 17 00:00:00 2001 From: rihitosan <76610702+rihitosan@users.noreply.github.com> Date: 2021年9月25日 12:31:08 +0900 Subject: [PATCH 4/4] Update README.md --- docs/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/README.md b/docs/README.md index c5c30f7..4af7ae5 100644 --- a/docs/README.md +++ b/docs/README.md @@ -15,8 +15,8 @@ ## language -* [English](./) -* [Japanese](./jp) +* [English](#/) +* [Japanese](jp/) ## Screencast