ドキュメントには頻繁に更新が加えられ、その都度公開されています。本ページの翻訳はまだ未完成な部分があることをご了承ください。最新の情報については、英語のドキュメンテーションをご参照ください。本ページの翻訳に問題がある場合はこちらまでご連絡ください。

ウィキについて

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

WikiはGitHub Free及びOrganizationのGitHub Freeのパブリックリポジトリ、GitHub Pro、GitHub Team、GitHub Enterprise Cloud、GitHub Enterprise Serverのパブリック及びプライベートリポジトリで利用できます。 詳しい情報については「GitHubの製品」を参照してください。

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

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

パブリックリポジトリにenterprise を作成すると、なら誰でもそのenterprise を利用できます。 内部またはプライベートリポジトリにenterprise を作成すると、リポジトリにアクセスできるユーザもenterprise にアクセスできます。 詳細は「リポジトリの可視性を設定する」を参照してください。

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

参考リンク

Did this doc help you?

Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

OR, learn how to contribute.