Skip to main content

ウィキについて

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

WikiはGitHub AEのインターナル及びプライベートリポジトリで利用できます。WikiはGitHub Free及びOrganizationのGitHub Freeのパブリックリポジトリ、GitHub Pro、GitHub Team、GitHub Enterprise Cloud、GitHub Enterprise Serverのパブリック及びプライベートリポジトリで利用できます。

GitHub AE のすべてのリポジトリには、Wiki と呼ばれるドキュメントをホストするためのセクションが用意されています。 リポジトリのウィキは、プロジェクトの利用方法、設計方法、中核的な原理など、プロジェクトに関する長いコンテンツを共有するために利用できます。 README ファイルは、プロジェクトができることを手短に述べますが、ウィキを使えば追加のドキュメンテーションを提供できます。 詳細については、「README について」を参照してください。

ウィキでは、GitHub AE のあらゆる他の場所と同じようにコンテンツを書くことができます。 詳細については、「GitHub での書き込みと書式設定の概要」を参照してください。 私たちは、さまざまなフォーマットを HTML に変更するのに私たちのオープンソース マークアップ ライブラリを使っているので、Markdown あるいはその他のサポートされているフォーマットで書くことができます。

プライベート リポジトリに Wiki を作成した場合、リポジトリにアクセスできるエンタープライズ メンバーのみが Wiki にアクセスできます。 詳細については、「リポジトリの可視性を設定する」を参照してください。

ウィキは、GitHub AE 上で直接編集することも、ウィキのファイルをローカルで編集することもできます。 デフォルトでは、リポジトリへの書き込みアクセス権を持つユーザのみが Wiki に変更を加えることができますが、your enterprise のすべてのユーザが内部リポジトリの Wiki に貢献できるようにすることも可能ですす。 詳しい情報については、「Wiki へのアクセス権限の変更」を参照してください。

注: 検索エンジンでは、Wiki のコンテンツのインデックスは作成されません。 検索エンジンによってコンテンツのインデックスを作成するには、パブリック リポジトリで GitHub Pages を使用します。

参考資料