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