GitHub.com のすべてのリポジトリには、Wiki と呼ばれるドキュメントをホストするためのセクションが用意されています。 リポジトリのウィキは、プロジェクトの利用方法、設計方法、中核的な原理など、プロジェクトに関する長いコンテンツを共有するために利用できます。 README ファイルは、プロジェクトができることを手短に述べますが、ウィキを使えば追加のドキュメンテーションを提供できます。 詳しくは、「READMEについて」を参照してください。
ウィキでは、GitHub Enterprise Cloud のあらゆる他の場所と同じようにコンテンツを書くことができます。 詳しくは、「GitHub での記述と書式設定の開始」を参照してください。 私たちは、さまざまなフォーマットを HTML に変更するのに私たちのオープンソース マークアップ ライブラリを使っているので、Markdown あるいはその他のサポートされているフォーマットで書くことができます。
Markdown を使用して、レンダリングされた数式、ダイアグラム、マップ、3D モデルを Wiki に追加できます。 レンダリングされた数式の作成の詳細については、「数式の記述」を参照してください。 ダイアグラム、マップ、3D モデルの作成の詳細については、「ダイアグラムの作成」を参照してください。
パブリック リポジトリに Wiki を作成すると、パブリックにアクセスできるすべてのユーザーがその Wiki を利用できます。 プライベートまたは内部 リポジトリに Wiki を作成した場合、リポジトリにアクセスできるユーザーのみが Wiki にアクセスできます。 詳しくは、「リポジトリの可視性を設定する」を参照してください。
ウィキは、GitHub Enterprise Cloud 上で直接編集することも、ウィキのファイルをローカルで編集することもできます。 デフォルトでは、リポジトリへの書き込みアクセス権を持つユーザのみが Wiki に変更を加えることができますが、GitHub.com のすべてのユーザがパブリックリポジトリの Wiki に貢献できるようにすることも可能です。 詳しくは、「Wiki へのアクセス権限の変更」を参照してください。
注: 検索エンジンを使うと、パブリック編集を防ぐために構成した star が 500 個以上付いている Wiki のみにインデックスが作成されます。 詳しくは、「Wiki へのアクセス権限の変更」を参照してください。
コンテンツにインデックスを作成するために検索エンジンが必要な場合は、パブリック リポジトリで GitHub Pages を使うことができます。