Every repository on GitHub.com comes equipped with a section for hosting documentation, called a wiki. リポジトリのウィキは、プロジェクトの利用方法、設計方法、中核的な原理など、プロジェクトに関する長いコンテンツを共有するために利用できます。 README ファイルは、プロジェクトができることを手短に述べますが、ウィキを使えば追加のドキュメンテーションを提供できます。 詳細は「README について」を参照してください。
ウィキでは、GitHub Enterprise Cloud のあらゆる他の場所と同じようにコンテンツを書くことができます。 詳細は「GitHub で書き、フォーマットしてみる」を参照してください。 私たちは、さまざまなフォーマットを HTML に変更するのに私たちのオープンソースマークアップライブラリを使っているので、Markdown あるいはその他任意のサポートされているフォーマットで書くことができます。
パブリックリポジトリに Wiki を作成すると、パブリックにアクセスできるすべてのユーザがその Wiki を利用できます。 If you create a wiki in a private or internal repository, only people with access to the repository can access the wiki. 詳細は「リポジトリの可視性を設定する」を参照してください。
ウィキは、GitHub Enterprise Cloud 上で直接編集することも、ウィキのファイルをローカルで編集することもできます。 デフォルトでは、リポジトリへの書き込みアクセス権を持つユーザのみが Wiki に変更を加えることができますが、GitHub.com のすべてのユーザがパブリックリポジトリの Wiki に貢献できるようにすることも可能ですす。 詳細は「ウィキへのアクセス権限を変更する」を参照してください。
注釈: 検索エンジンによる、Wikiコンテンツのインデックス化はありません。 検索エンジンでコンテンツをインデックスするには、パブリックリポジトリで GitHub Pages を使用します。