Wiki

各リポジトリではWikiをホストできます。Wikiは、コードと混在させることなくコードの隣に置いておける、ドキュメント用のMarkdownページの独立したコレクションです。

Wikiの有効化

1. リポジトリを開き、設定を選択します。
2. 機能で、Wiki をオンにします。
3. リポジトリのナビゲーションに Wiki タブが表示されます。

ページの作成と編集

1. Wiki タブを選択します。
2. Wikiにまだページがない場合は、Create the First Page を選択します。ある場合は、New Page を選択します。
3. ページのタイトルを入力します。タイトルはそのページのURLになるため、わかりやすく、変わりにくいものを選択してください。
4. Markdownで内容を記述し、Save Page を選択します。

最初に作成したページが、Wikiのホームになります。これは、訪問者がデフォルトで最初に表示するページです。既存のページを更新するには、ページを開いて編集を選択します。保存するたびに、そのページのリビジョン履歴に新しいエントリーが記録されます。

ノート

Wikiは、コードと同様にバージョン管理されます。任意のページで Revisions ビューを開くと、履歴を参照したり、以前のバージョンに戻したりできます。

Wikiの整理

特別な名前を持つ2つのページが、Wiki全体のナビゲーションを制御します。

• _Sidebar — すべてのページに表示されるカスタムサイドバーです。ここに、最も重要なページへのリンクを追加します。
• _Footer — すべてのページの下部に表示されるフッターです。

どちらも、New Page から上記のとおりの名前で作成します。Wikiのページ間は、ページのスラッグを参照する標準のMarkdownでリンクします。

See the [Setup Guide](setup-guide) for installation steps.

最初からわかりやすいページタイトルを付けてください。タイトルがURLになるため、後でページの名前を変更すると、そのページへの既存のリンクが壊れます。

Wikiのローカルでの編集

Wiki自体もGitリポジトリであり、リポジトリの .wiki.git のURLから利用できます。クローンして、エディターでMarkdownファイルを編集し、変更をプッシュします。

git clone https://git.example.plaidcloud.com/you/my-repo.wiki.git
cd my-repo.wiki
# edit or add .md files
git add .
git commit -m "Expand the setup guide"
git push

メインのリポジトリで使用しているのと同じ個人用アクセストークンが、ここでも使用できます。各Markdownファイルが1つのWikiページになり、ファイル名（.md 拡張子を除く）がページのスラッグになります。

次のステップ

• リポジトリの操作
• 課題による作業の追跡