ウィキについて

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

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

パブリックリポジトリ内のウィキはパブリックに利用でき、プライベートリポジトリではリポジトリにアクセスできる人々に限定されます。 詳細は「リポジトリの可視性を設定する」を参照してください。

ウィキは、GitHub 上で直接編集することも、ウィキのファイルをローカルで編集することもできます。 デフォルトでは、リポジトリに書き込みアクセスを持っている人だけがウィキを変更できますが、パブリックリポジトリ内のウィキには GitHub 上の誰もがコントリビューションできるようにすることができます。 詳細は「ウィキへのアクセス権限を変更する」を参照してください。

参考リンク

• 「ウィキページを追加または編集する」
• 「ウィキにフッタやサイドバーを作成する」
• 「ウィキのコンテンツを編集する」
• Wkiの変更履歴の表示
• Wikiの検索