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

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

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

ウィキは、GitHub Free及びGitHub FreeのOrganizationのパブリックリポジトリ、GitHub Pro 、GitHub Team、GitHub Enterprise Cloud、GitHub Enterprise Server のパブリックおよびプライベートリポジトリで利用できます。 For more information, see "GitHub's products."

ここには以下の内容があります:

Did this doc help you?

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.

ウィキページを追加する

  1. GitHubで、リポジトリのメインページにアクセスしてください。
  2. リポジトリ名の下で Wiki(ウィキ)をクリックしてください。
    ウィキメニューリンク
  3. ページの右上にある [New Page] をクリックします。
    ウィキの新規ページボタン
  4. Markdown 以外のフォーマットで書くために、[Edit mode] ドロップダウンメニューを使い、他のフォーマットをクリックすることもできます。
    ウィキのマークアップの選択
  5. テキストエディタを使って、ページの内容を追加してください。
    ウィキの WYSIWYG
  6. 追加しようとしている新しいファイルを説明するコミットメッセージを入力してください。
    ウィキのコミットメッセージ
  7. 変更を wiki にコミットするには [Save Page] をクリックします。

ウィキページを編集する

  1. GitHubで、リポジトリのメインページにアクセスしてください。
  2. リポジトリ名の下で Wiki(ウィキ)をクリックしてください。
    ウィキメニューリンク
  3. ウィキサイドバーを使用して、変更したいページに移動してください。 ページの右上にある [Edit] をクリックしてください。
    ウィキのページ編集ボタン
  4. テキストエディタを使って、ページの内容を編集します。
    ウィキの WYSIWYG
  5. 変更内容を説明するコミットメッセージを入力します。
    ウィキのコミットメッセージ
  6. 変更を wiki にコミットするには [Save Page] をクリックします。

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

ウィキは Git のリポジトリの一部なので、Git ワークフローを使ってローカルで変更を加え、リポジトリにプッシュできます。

手元のコンピュータへウィキをクローンする

すべてのウィキは、その内容をあなたのコンピュータにクローンする簡単な方法を提供しています。 提供されている次の URL でお使いのコンピュータにリポジトリをクローンできます。

$ git clone https://github.com/YOUR_USERNAME/YOUR_REPOSITORY.wiki.git
# ローカルに wiki をクローン

wiki をクローンした後は、新しいファイルの追加、既存のファイルの編集、変更のコミットができます。 You and your collaborators can create branches when working on wikis, but only changes pushed to the default branch will be made live and available to your readers.

ウィキのファイル名について

wiki のページのタイトルはファイル名で決まり、ファイルの拡張子で wiki の内容の描画方法が決まります。

wiki は弊社のオープンソースマークアップライブラリでマークアップに変換され、ライブラリはファイルの拡張子によって使用するコンバータが決定されます。 たとえばファイルに foo.md あるいは foo.markdown という名前を付けた場合、wiki は Markdown コンバータを使います。一方で、foo.textile という名前のファイルには Textile コンバータが使われます。

wiki ページのタイトルには \ / : * ? " < > | という文字は使わないでください。 特定のオペレーティングシステムのユーザは、これらの文字を含むファイル名を扱えません。 内容を書く上では、拡張子にマッチしたマークアップ言語を使ってください。そうなっていない場合、内容は正しく描画されません。

Did this doc help you?

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.