Skip to main content

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

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

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

ウィキページを追加する

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

ウィキページを編集する

  1. your GitHub Enterprise Server instance で、リポジトリのメイン ページへ移動します。 1. リポジトリ名の下の [Wiki] をクリックします。 Wiki メニュー リンク
  2. ウィキサイドバーを使用して、変更したいページに移動してください。 ウィンドウの右上にある [Edit](編集) をクリックします。 Wiki のページ編集ボタン
  3. テキスト エディターを使って、ページの内容を編集します。 Wiki の WYSIWYG
  4. 変更内容を説明するコミットメッセージを入力します。 Wiki のコミット メッセージ
  5. 変更を 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 ページのタイトルには次の文字を使用しないでください: \ / : * ? " < > |。 特定のオペレーティングシステムのユーザは、これらの文字を含むファイル名を扱えません。 内容を書く上では、拡張子にマッチしたマークアップ言語を使ってください。そうなっていない場合、内容は正しく描画されません。