Skip to main content

ウィキでプロジェクトを文書化する

ウィキを使用してプロジェクトに関する具体的な長文形式の情報を共有できます。

この機能を使用できるユーザーについて

Wikiは、組織の場合はGitHub FreeとGitHub Freeのパブリック・リポジトリで、パブリックおよびプライベート・リポジトリではGitHub Pro、GitHub Team、GitHub Enterprise Cloud、GitHub Enterprise Serverで利用できます。 詳しくは、「GitHub のプラン」をご覧ください。

ウィキについて

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

ウィキページを追加または編集する

ウィキページは、GitHub 上で直接、あるいはコマンドラインを使ってローカルで追加および編集できます。

ウィキにフッタやサイドバーを作成する

カスタムのサイドバーやフッタをウィキに追加して、さらに多くのコンテキスト情報を読者に提供できます。

ウィキのコンテンツを編集する

ウィキ内のコンテンツに画像やリンクを追加したり、一部のサポートされている MediaWiki 形式を使用したりできます。

ウィキの変更履歴を表示する

ウィキは Git リポジトリであるため、行うすべての変更は、表示できるコミットです。

Wiki へのアクセス権限の変更

既定では、リポジトリ コラボコラボレーターのみパブリック リポジトリの Wiki を編集できますが、GitHub.comでアカウントを持っているユーザー全員に対して、お持ちの Wiki の編集を許可することができます。

ウィキを無効化する

リポジトリのウィキを無効化できます。