diff --git a/docs/config.md b/.config/example.yml similarity index 98% rename from docs/config.md rename to .config/example.yml index c4a54c0bee..0e167ccb77 100644 --- a/docs/config.md +++ b/.config/example.yml @@ -1,4 +1,3 @@ -``` yaml # サーバーのメンテナ情報 maintainer: # メンテナの名前 @@ -56,5 +55,3 @@ twitter: # インテグレーション用アプリのコンシューマーシークレット consumer_secret: - -``` diff --git a/.gitignore b/.gitignore index d0ae0b8085..be8689e2ed 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ -/.config +/.config/* +!/.config/example.yml /.vscode /node_modules /build diff --git a/docs/setup.en.md b/docs/setup.en.md index 08cd16857d..a436d751c8 100644 --- a/docs/setup.en.md +++ b/docs/setup.en.md @@ -37,9 +37,9 @@ Please install and setup these softwares: *3.* Prepare configuration ---------------------------------------------------------------- -First, you need to create a `.config` directory in the directory that -Misskey installed. And then you need to create a `default.yml` file in -the directory. The template of configuration is available [here](./config.md). +1. Copy `example.yml` of `.config` directory +2. Rename it to `default.yml` +3. Edit it *4.* Install and build Misskey ---------------------------------------------------------------- diff --git a/docs/setup.ja.md b/docs/setup.ja.md index 9fa56acb22..6605461d9f 100644 --- a/docs/setup.ja.md +++ b/docs/setup.ja.md @@ -37,9 +37,9 @@ web-push generate-vapid-keys *3.* 設定ファイルを用意する ---------------------------------------------------------------- -Misskeyをインストールしたディレクトリに、`.config`というディレクトリを作成し、 -その中に`default.yml`という名前で設定ファイルを作ってください。 -設定ファイルの下書きは[ここ](./config.md)にありますので、コピペしてご利用ください。 +1. `.config`ディレクトリ内の`example.yml`をコピー +2. `default.yml`にリネーム +3. 編集する *4.* Misskeyのインストール(とビルド) ----------------------------------------------------------------