# ウィキについて

リポジトリのドキュメンテーションをウィキでホストして、他者が利用してプロジェクトにコントリビュートすることを可能にできます。

GitHub のすべてのリポジトリに、Wiki と呼ばれるドキュメントをホストするセクションが備わっています。 リポジトリのウィキは、プロジェクトの利用方法、設計方法、中核的な原理など、プロジェクトに関する長いコンテンツを共有するために利用できます。 README ファイルは、プロジェクトができることを手短に述べますが、ウィキを使えば追加のドキュメンテーションを提供できます。 詳しくは、「[リポジトリの README ファイルについて](/ja/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes)」をご覧ください。

Wiki を使用すると、GitHub の他の場所と同じようにコンテンツを作成できます。 詳しくは、「[GitHub での記述と書式設定の開始](/ja/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github)」をご覧ください。 私たちは、さまざまなフォーマットを HTML に変更するのに[私たちのオープンソース マークアップ ライブラリ](https://github.com/github/markup)を使っているので、Markdown あるいはその他のサポートされているフォーマットで書くことができます。

Markdown を使って、レンダリングされた数式、ダイアグラム、マップ、3D モデルを Wiki に追加できます。 レンダリングされた数式の作成について詳しくは、「[数式の記述](/ja/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions)」をご覧ください。 ダイアグラム、マップ、3D モデルの作成の詳細については、「[ダイアグラムの作成](/ja/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams)」を参照してください。

パブリック リポジトリに Wiki を作成すると、Wiki は、一般公開されます。 プライベート リポジトリに Wiki を作成した場合、そのリポジトリにアクセスできるユーザーのみが Wiki にアクセスできます。 詳しくは、「[リポジトリの可視性を設定する](/ja/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility)」をご覧ください。

Wiki は、GitHub 上で直接編集することも、Wiki のファイルをローカルで編集することもできます。 デフォルトでは、リポジトリへの書き込みアクセス権を持つユーザのみが Wiki に変更を加えることができますが、GitHub.com のすべてのユーザがパブリック リポジトリの Wiki に貢献できるようにすることも可能です。 詳しくは、「[Wiki へのアクセス権限の変更](/ja/communities/documenting-your-project-with-wikis/changing-access-permissions-for-wikis)」をご覧ください。

> \[!NOTE]
> 検索エンジンは、500 個以上のスターが付いていて、パブリック編集を防ぐように設定された Wiki のみをインデックスします。 詳しくは、「[Wiki へのアクセス権限の変更](/ja/communities/documenting-your-project-with-wikis/changing-access-permissions-for-wikis)」をご覧ください。
>
> コンテンツにインデックスを作成するために検索エンジンが必要な場合は、パブリック リポジトリで GitHub Pages を使うことができます。 詳しくは、「[GitHub Pages](/ja/pages)」をご覧ください。

> \[!NOTE]
> パフォーマンス上の理由から、Wiki にはファイルの種類に関係なく、ファイル数合計 5,000 のソフト制限があります。 この制限を超えると、一部のページにユーザーがアクセスできなくなる場合があります。 より大きな Wiki が必要な場合は、GitHub Pages を使用することをお勧めします。 詳しくは、「[GitHub Pages](/ja/pages)」をご覧ください。

## 参考資料

* [ウィキページを追加または編集する](/ja/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages)
* [ウィキにフッタやサイドバーを作成する](/ja/communities/documenting-your-project-with-wikis/creating-a-footer-or-sidebar-for-your-wiki)
* [ウィキのコンテンツを編集する](/ja/communities/documenting-your-project-with-wikis/editing-wiki-content)
* [ウィキの変更履歴を表示する](/ja/communities/documenting-your-project-with-wikis/viewing-a-wikis-history-of-changes)
* [ウィキを検索する](/ja/search-github/searching-on-github/searching-wikis)