執筆をはじめる

編集環境のセットアップ

リポジトリをGitHub上でフォークし、フォークしたリポジトリをチェックアウトします。

git clone git@github.com:自分のアカウント/フォーク先のリポジトリ名.git

必要なツールをインストールします。

yarn

開発サーバーを起動します。

yarn start

開発サーバーが起動したら、ブラウザでhttp://localhost:3000を開きます。

新しいページを作る

作業のとりかかり

docsディレクトリに新規ページのMarkdownファイルを追加します。

mkdir -p docs/カテゴリ名/サブカテゴリ名touch docs/カテゴリ名/サブカテゴリ名/new-page.md

sidebars.jsに新規ページへのパスを追加します。パスには拡張子.mdを含めません。

sidebars.js

module.exports = {  // ...  tutorialSidebar: [    {      type: "category",      label: "カテゴリ名",      items: [        {          type: "category",          label: "サブカテゴリ名",          items: [            "カテゴリ名/サブカテゴリ名/new-page",          ],        },      ],    },  ],};

ここまで完了したら、作成したファイルを編集していきます。

編集後にやること

作成したファイルを編集したらコミットします。

git add docs/カテゴリ名/サブカテゴリ名/new-page.mdgit commit -m "「新しいページ」を追加しました。"

tip

コミットメッセージは日本語で構いません。

コミットメッセージの例:

• 「型注釈」を追加しました。
• 「関数」にサンプルコードを追加しました。
• 誤字「使用」を「仕様」に修正しました。

コンテンツの自動修正

コードスタイルの修正

Prettierとmarkdownlintで、Markdownの記法スタイルやコードブロック内のTypeScriptコードスタイルを修正します。

yarn markdownlint:fixyarn prettier:fix

tip

Prettierの自動整形をさせたくないコードブロックには<!--prettier-ignore-->をつけます。

<!--prettier-ignore-->```typescripttype Code =  | 1  | 2  | 3;```

tip

markdownlintで指摘されたエラーの詳細はmarkdownlintのドキュメントをご覧ください。

日本語の校正

textlintで日本語に問題がないかチェックします。

yarn textlint

textlintで問題が指摘された箇所で、変更すべきところを変更します。

tip

textlint指摘箇所をすべて直していい場合はyarn textlint:fixで一括修正できます。

自動修正内容をコミット

自動修正の結果は差分で確認します。

git diff

tip

自動修正による変更をもとに戻すには、git checkoutを使います。

自動修正の内容に問題がなければコミットします。

git add docs/カテゴリ名/サブカテゴリ名/new-page.mdgit commit --amend # 直前のコミットに含めて、コミットを1つにする方法です

プルリクエストを送る

caution

プルリクエストを送る前にコミットが1つになっているか確認してください。

変更内容をpushします。

git push

GitHub上でプルリクエストを作成します。プルリクエストが作成されると、CIが走りコードスタイルなどのチェックが行われます。CIに問題がなければマージされます。