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

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

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

Wikiは、組織の場合はGitHub FreeとGitHub Freeのパブリック・リポジトリで、パブリックおよびプライベート・リポジトリではGitHub Pro、GitHub Team、GitHub Enterprise Cloud、GitHub Enterprise Serverで利用できます。

この記事の内容

ウィキページを追加する

  1. GitHub で、リポジトリのメイン ページに移動します。

  2. リポジトリ名の下の [Wiki] を選択します。

    リポジトリ内のメニューのスクリーンショット。 [Wiki] オプションが濃いオレンジ色の枠線で囲まれています。

  3. ページの右上隅にある New Page をクリックします

  4. 必要に応じて、Markdown 以外のフォーマットで記述するために、[編集モード] ドロップダウンを使って他のフォーマットを選びます。

    [新しいページの作成] ページのスクリーンショット。 [編集モード] ドロップダウンが濃いオレンジ色の枠線で囲まれています。

  5. テキストエディタを使って、ページの内容を追加してください。

  6. [メッセージの編集] フィールドに、追加する新しいファイルを説明するコミット メッセージを入力します。

  7. 変更を Wiki にコミットするには、 Save Page をクリックします。

ウィキページを編集する

  1. GitHub で、リポジトリのメイン ページに移動します。

  2. リポジトリ名の下の [Wiki] を選択します。

    リポジトリ内のメニューのスクリーンショット。 [Wiki] オプションが濃いオレンジ色の枠線で囲まれています。

  3. 右にある Wiki サイドバーを使用して、変更したいページに移動してください。 ウィンドウの右上にある Edit をクリックします。

  4. テキスト エディターを使って、ページの内容を編集します。

  5. [メッセージの編集] フィールドに、追加する新しいファイルを説明するコミット メッセージを入力します。

  6. 変更を Wiki にコミットするには、 Save Page をクリックします。

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

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

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

すべてのウィキは、その内容をあなたのコンピュータにクローンする簡単な方法を提供しています。 GitHub Enterprise Server に最初のページを作成したら、指定した URL のコンピューターにリポジトリをクローンすることができます。

$ git clone https://github.com/YOUR-USERNAME/YOUR-REPOSITORY.wiki.git
# Clones the wiki locally

wiki をクローンした後は、新しいファイルの追加、既存のファイルの編集、変更のコミットができます。 ユーザとコラボレータは、Wiki で作業するときにブランチを作成できますが、デフォルトブランチにプッシュされた変更のみがライブになり、読者はそれのみを利用できます。

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

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

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

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