ウィキのコンテンツを編集する

ウィキ内のコンテンツに画像やリンクを追加したり、一部のサポートされている MediaWiki 形式を使用したりできます。

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

Wikiは、組織の場合はGitHub FreeとGitHub Freeのパブリック・リポジトリで、パブリックおよびプライベート・リポジトリではGitHub Pro、GitHub Team、GitHub Enterprise Cloud、GitHub Enterprise Serverで利用できます。 詳しくは、「GitHub のプラン」をご覧ください。

この記事の内容

ページでサポートされている標準的なマークアップや MediaWiki の構文を使ってウィキにリンクを作成できます。 次に例を示します。

  • ページが Markdown でレンダリングされる場合、リンク構文は [Link Text](full-URL-of-wiki-page) です。
  • MediaWiki 構文では、リンク構文は [[Link Text|nameofwikipage]] です。

イメージの追加

ウィキでは PNG、JPEG、および GIF 画像を表示できます。

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

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

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

  3. Wiki サイドバーを使用して、変更するページに移動し、 [編集] をクリックします。

  4. Wiki ツール バーで、 を選択します。

    Wiki の編集ページのツール バーのスクリーンショット。 画像を追加するアイコンが濃いオレンジ色の枠線で囲まれています。

  5. [Insert Image] ダイアログボックスで、画像の URL と代替テキスト (これは検索エンジンや画像リーダーで使われます) を入力します。

  6. [OK] をクリックします。

リポジトリでの画像へのリンク

GitHub上のリポジトリにある画像は、ブラウザで URL をコピーし、それを画像へのパスとして利用することでリンクできます。 たとえば、Markdown を使ってウィキに画像を埋め込むと、以下のようになります:

[[https://github.com/USERNAME/REPOSITORY/blob/main/img/octocat.png|alt=octocat]]

数式とダイアグラムの追加

Markdown を使用して、レンダリングされた数式、ダイアグラム、マップ、3D モデルを Wiki に追加できます。 レンダリングされた数式の作成の詳細については、「数式の記述」を参照してください。 ダイアグラム、マップ、3D モデルの作成の詳細については、「ダイアグラムの作成」を参照してください。

サポートされる MediaWiki 形式

ウィキがどのマークアップ言語で書かれたかにかかわらず、特定の MediaWiki 構文を常に使用できます。

  • リンク (AsciiDoc を除く)
  • --- を介した水平ルール
  • 短縮記号エンティティ (δ または € など)

セキュリティとパフォーマンス上の理由により、一部の構文はサポートされていません。