ウィキについて

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

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

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

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

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

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

注釈: 検索エンジンによる、Wikiコンテンツのインデックス化はありません。 検索エンジンでコンテンツをインデックスするには、パブリックリポジトリで GitHub Pages を使用します。

参考リンク

このドキュメントは役立ちましたか?

プライバシーポリシー

これらのドキュメントを素晴らしいものにするのを手伝ってください!

GitHubのすべてのドキュメントはオープンソースです。間違っていたり、はっきりしないところがありましたか?Pull Requestをお送りください。

コントリビューションを行う

OR, コントリビューションの方法を学んでください。

問題がまだ解決していませんか?