正式なドキュメントは英語版であり、この日本語訳はAI支援翻訳により作成された参考用のものです。日本語訳の一部の内容は人間によるレビューがまだ行われていないため、翻訳のタイミングにより英語版との間に差異が生じることがあります。最新かつ正確な情報については、英語版をご参照ください。
ドキュメントに関する現在のご利用体験についてお聞かせください。アンケートにご協力ください。

Wiki

  • プラン: Free、Premium、Ultimate
  • 提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated

Wikiは、プロジェクトやグループのドキュメントを使い慣れた形式で提供します。Wikiページには次のような機能があります。

  • Markdown、RDoc、AsciiDoc、Org形式で、技術ドキュメント、ガイド、ナレッジベースを生成する。
  • GitLabプロジェクトとグループと直接統合される共同編集ドキュメントを作成する。
  • バージョン管理とコラボレーションのために、ドキュメントをGitリポジトリに保存する。
  • サイドバーのカスタマイズによるカスタムナビゲーションと構成をサポートする。
  • オフラインアクセスと共有のために、コンテンツをPDFファイルとしてエクスポートする。
  • コードベースとは別にコンテンツを管理しながら、同じプロジェクト内に保持する。
  • フィードバックとエンゲージメントのために、ページで絵文字リアクションをサポートする。

各Wikiは、個別のGitリポジトリです。GitLab Webインターフェースまたはローカル環境のGitを使用して、Wikiページを作成および編集できます。Markdownで記述されたWikiページは、すべてのMarkdown機能をサポートし、リンクについてはWiki固有の動作を提供します。

Wikiページにはサイドバーが表示されます。サイドバーはカスタマイズも可能です。

プロジェクトWikiを表示する

プロジェクトWikiにアクセスするには:

  1. 上部のバーで、検索または移動先を選択して、プロジェクトを見つけます。
  2. 左側のサイドバーで、計画 > Wikiを選択します。

プロジェクトの左側のサイドバーに計画 > Wikiが表示されない場合、プロジェクト管理者によって無効にされています。

Wikiのデフォルトブランチを設定する

Wikiリポジトリは、インスタンスまたはグループからデフォルトブランチ名を継承します。カスタムブランチ名が設定されていない場合、GitLabはmainを使用します。Wikiのデフォルトブランチ名を変更するには、リポジトリ内でデフォルトブランチ名を更新します。

Wikiホームページを作成する

作成時点ではWikiは空です。初回アクセス時に、ユーザーがWikiを閲覧する際に表示されるホームページを作成できます。このページをWikiのホームページとして使用するには、特定のパスが必要です。作成するには:

  1. 上部のバーで、検索または移動先を選択して、プロジェクトまたはグループを見つけます。
  2. 左側のサイドバーで、計画 > Wikiを選択します。
  3. 最初のページを作成を選択します。
  4. オプション。ホームページのタイトルを変更します。
  5. GitLabでは、この最初のページのパスをhomeにする必要があります。このパスのページがWikiのフロントページになります。
  6. オプション。ページオプションを編集（ chevron-down ）を選択して、次の操作を行います:
    • ページのパスを変更します。デフォルトでは、パスはタイトルから生成されます。ページパスでは、サブディレクトリと書式設定に特殊文字を使用します。また、パスには長さ制限があります。
    • コンテンツのフォーマットを変更します。
    • テンプレートを選択します。詳細については、テンプレートから作成するを参照してください。
  7. コンテンツエリアにホームページのウェルカムメッセージを追加します。これは後からいつでも編集できます。
  8. ページを作成を選択します。保存前にコミットメッセージを追加するには、ページを作成の横にある矢印を選択し、メッセージ付きで変更を保存を選択します。

新しいWikiページを作成する

前提条件:

  • デベロッパー、メンテナー、またはオーナーロール。

プロジェクトまたはグループから新しいWikiページを作成するには:

  1. 上部のバーで、検索または移動先を選択して、グループまたはプロジェクトを見つけます。
  2. 右上隅で、新規作成（ plus ）を選択し、新しいWikiページを選択します。

または:

  1. 上部のバーで、検索または移動先を選択して、プロジェクトまたはグループを見つけます。
  2. 左側のサイドバーで、計画 > Wikiを選択します。
  3. このページまたは他のWikiページで、Wikiアクション（ ellipsis_v ）を選択し、次に新しいページを選択します。

新しいページフォームを開いたら、次の手順を実行します:

  1. エディタのヘッダーで新しいページのタイトルを追加します。
  2. オプション。ページオプションを編集（ chevron-down ）を選択して、次の操作を行います:
    • ページのパスを変更します。デフォルトでは、パスはタイトルから生成されます。ページパスでは、サブディレクトリと書式設定に特殊文字を使用します。また、パスには長さ制限があります。
    • コンテンツのフォーマットを変更します。
    • テンプレートを選択します。詳細については、テンプレートから作成するを参照してください。
  3. オプション。Wikiページにコンテンツを追加します。
  4. オプション。ファイルを添付します。GitLabはそのファイルをWikiのGitリポジトリに保存します。
  5. ページを作成を選択します。保存前にコミットメッセージを追加するには、ページを作成の横にある矢印を選択し、メッセージ付きで変更を保存を選択します。

テンプレートから作成する

プロジェクトに少なくとも1つのテンプレートがある場合、テンプレートから新しいWikiページを作成できます。

前提条件:

  • テンプレートを少なくとも1つ作成済みであること。
  1. 上部のバーで、検索または移動先を選択して、プロジェクトまたはグループを見つけます。
  2. 左側のサイドバーで、計画 > Wikiを選択します。
  3. テンプレートを選択して、利用可能なすべてのテンプレートを表示します。
  4. 使用するテンプレートの横にあるテンプレートから作成するを選択します。
  5. 新しいページフォームが開き、次の状態になります:
    • コンテンツエリアにテンプレートの内容が事前に入力されている。
    • テンプレートのドロップダウンリストで、そのテンプレートが選択されている。
  6. 新しいページのタイトルを入力します。
  7. 必要に応じてコンテンツを変更します。
  8. ページを作成を選択します。
  1. 上部のバーで、検索または移動先を選択して、プロジェクトまたはグループを見つけます。
  2. 左側のサイドバーで、計画 > Wikiを選択します。
  3. テンプレートを選択して、利用可能なすべてのテンプレートを表示します。
  4. 使用するテンプレートを選択します。
  5. ページヘッダーで、テンプレートから作成するを選択します。
  6. 新しいページフォームが開き、現在のテンプレートが事前に選択され、その内容が読み込まれた状態になります。
  7. 新しいページのタイトルを入力します。
  8. 必要に応じてコンテンツを変更します。
  9. ページを作成を選択します。
  1. 上部のバーで、検索または移動先を選択して、プロジェクトまたはグループを見つけます。
  2. 左側のサイドバーで、計画 > Wikiを選択します。
  3. 新しいページを選択します。
  4. テンプレートを選択するドロップダウンリストで、目的のテンプレートを選択します。
  5. テンプレートの内容がコンテンツエリアに自動的に読み込まれます。
  6. ページのタイトルを入力します。
  7. 必要に応じてコンテンツを変更します。
  8. ページを作成を選択します。

Wikiページをローカルで作成または編集する

WikiはGitリポジトリに基づいているため、ローカルにクローンを作成し、他のすべてのGitリポジトリと同様に編集できます。Wikiリポジトリのクローンをローカルに作成するには:

  1. 上部のバーで、検索または移動先を選択して、プロジェクトまたはグループを見つけます。
  2. 左側のサイドバーで、計画 > Wikiを選択します。
  3. Wikiアクション（ ellipsis_v ）を選択し、次にリポジトリをクローンを選択します。
  4. 画面の指示に従います。

ローカルでWikiに追加するファイルは、使用するマークアップ言語に応じて、次のいずれかのサポート対象拡張子を使用する必要があります。サポートされていない拡張子のファイルは、GitLabにプッシュしても表示されません。

  • Markdown拡張子: .mdown、.mkd、.mkdn、.md、.markdown。
  • AsciiDoc拡張子: .adoc、.ad、.asciidoc。
  • その他のマークアップ拡張子: .textile、.rdoc、.org、.creole、.wiki、.mediawiki、.rst。

ページパスの特殊文字

WikiページはGitリポジトリ内のファイルとして保存されます。また、デフォルトではページのファイル名がそのページのタイトルになっています。ファイル名に含まれる特定の文字には、特別な意味があります。

  • ページを保存するとき、スペースはハイフンに変換されます。
  • ページを表示するとき、ハイフン（-）は、スペースに変換されます。
  • スラッシュ（/）はパスの区切り文字として使用されます。タイトルには表示できません。/文字を含むタイトルのファイルを作成すると、GitLabはそのパスを構築するために必要なすべてのサブディレクトリを作成します。たとえば、タイトルをdocs/my-pageにすると、パスが/wikis/docs/my-pageのWikiページを作成します。

これらの制限を回避するため、ページコンテンツの前にあるフロントマターブロックにWikiページのタイトルを保存することもできます。例:

---
title: Page title
---

ファイル名とディレクトリ名の長さ制限

多くの一般的なファイルシステムでは、ファイル名とディレクトリ名に255バイトの制限があります。GitとGitLabはいずれも、これらの制限を超えるパスをサポートしています。ただし、ファイルシステムにこれらの制限が適用されている場合、この制限を超えるファイル名を含むWikiのローカルコピーをチェックアウトすることはできません。この問題を防ぐために、GitLab WebインターフェースとAPIでは次の制限が適用されます:

  • ファイル名は245バイト（ファイル拡張子用に10バイトを予約）。
  • ディレクトリ名は255バイト。

非ASCII文字は、1文字で複数バイトを使用します。

これらの制限を超えるファイルをローカルで作成することはできますが、その後、チームメイトがWikiをローカルでチェックアウトできなくなる可能性があります。

Wikiページを編集する

前提条件:

  • デベロッパー、メンテナー、またはオーナーロールが必要です。

Wikiエディタは、次の項目を含む固定ヘッダーとともに開きます:

  • ページのタイトル。インラインで編集できます。
  • ページのパスやフォーマットを変更する、またはテンプレートを選択するためのページオプションを編集（ chevron-down ）
  • Wikiサイドバーの表示と非表示を切り替えるためのサイドバー切替（ sidebar ）。
  • 変更を保存するための変更を保存、変更を破棄するためのキャンセル。

Wikiページを編集するには:

  1. 上部のバーで、検索または移動先を選択して、プロジェクトまたはグループを見つけます。
  2. 左側のサイドバーで、計画 > Wikiを選択します。
  3. 編集したいページに移動し、編集を選択します。
  4. コンテンツを編集します。
  5. 変更を保存を選択します。保存前にコミットメッセージを追加するには、変更を保存の横にある矢印を選択し、メッセージ付きで変更を保存を選択します。

ページをプレビューしてスクロールすると、ページ上部の固定バーから編集などのアクションに引き続きアクセスできます。

誤ってデータが失われるのを防ぐため、保存されていないWikiページの変更はローカルブラウザストレージに保持されます。

目次を作成する

コンテンツに見出しが含まれるWikiページでは、サイドバーに目次セクションが自動的に表示されます。

必要に応じて、ページ自体に別の目次セクションを表示することもできます。Wikiページのサブ見出しから目次を生成するには、[[_TOC_]]タグを使用します。例については、目次を参照してください。

Wikiページにリアクションする

Wikiページに直接絵文字リアクションを追加できます。リアクションは、ページコンテンツの下、コメントセクションの上に表示されます。

Wikiページにリアクションするには:

  1. 上部のバーで、検索または移動先を選択して、プロジェクトまたはグループを見つけます。
  2. 左側のサイドバーで、計画 > Wikiを選択します。
  3. リアクションするページに移動します。
  4. ページコンテンツの下で、既存の絵文字を選択してリアクションを追加するか、リアクションを追加（ slight-smile ）を選択して別の絵文字を選択します。

リアクションを削除するには、その絵文字をもう一度選択します。各ユーザーは、ページごとに各種類のリアクションを1つだけ追加できます。

ページに初めてリアクションを追加すると、GitLabはそのページの通知をサブスクライブします。

Wikiページを削除する

前提条件:

  • デベロッパー、メンテナー、またはオーナーロールが必要です。
  1. 上部のバーで、検索または移動先を選択して、プロジェクトまたはグループを見つけます。
  2. 左側のサイドバーで、計画 > Wikiを選択します。
  3. 削除するページに移動します。
  4. Wikiアクション（ ellipsis_v ）を選択し、次にページを削除を選択します。
  5. 削除を確認します。

Wikiページを移動または名前変更する

GitLab 17.1以降では、ページを移動するかページの名前を変更すると、古いページから新しいページへのリダイレクトが自動的に設定されます。リダイレクトのリストは、Wikiリポジトリの.gitlab/redirects.ymlファイルに保存されます。

前提条件:

  • デベロッパー、メンテナー、またはオーナーロールが必要です。
  1. 上部のバーで、検索または移動先を選択して、プロジェクトまたはグループを見つけます。
  2. 左側のサイドバーで、計画 > Wikiを選択します。
  3. 移動または名前を変更するページに移動します。
  4. 編集を選択します。
  5. エディタのヘッダーで、ページオプションを編集（ chevron-down ）を選択します。
  6. ページを移動するには、パスフィールドを変更します。たとえば、Companyの下にAboutというWikiページがあり、このページをWikiのルートに移動する場合は、パスをAboutから/Aboutに変更します。
  7. ページの名前を変更するには、パスを変更します。
  8. 変更を保存を選択します。

Wikiページをエクスポートする

Wikiページは、PDFファイルとしてエクスポートできます。

  1. 上部のバーで、検索または移動先を選択して、プロジェクトまたはグループを見つけます。
  2. 左側のサイドバーで、計画 > Wikiを選択します。
  3. エクスポートするページに移動します。
  4. 右上隅で、Wikiアクション（ ellipsis_v ）を選択し、次にPDFとして印刷を選択します。

WikiページのPDFが作成されます。

Draw.ioを使用してWikiで図を作成する

diagrams.netインテグレーションを使用すると、SVG図を作成してWikiページに埋め込むことができます。図エディタは、プレーンテキストエディタとリッチテキストエディタの両方で使用できます。

GitLab.comでは、このインテグレーションがすべてのユーザーに対して有効になっており、追加の設定は必要ありません。

GitLab Self-Managedでは、無料のdiagrams.net Webサイトと統合したり、オフライン環境で独自のdiagrams.netサイトをホストしたりできます。

インテグレーションを設定するには、次の操作が必要です:

  1. 無料のdiagrams.net Webサイトと統合するか、diagrams.netサーバーを設定します。
  2. インテグレーションを有効にします。

インテグレーションが完了すると、指定したURLでdiagrams.netエディタが開きます。

Wikiページテンプレート

新しいページを作成する際に使用するテンプレートや、既存のページに適用するテンプレートを作成できます。テンプレートは、Wikiリポジトリのtemplates/ディレクトリに保存されるWikiページです。

テンプレートを作成する

前提条件:

  • デベロッパー、メンテナー、またはオーナーロールが必要です。
  1. 上部のバーで、検索または移動先を選択して、プロジェクトまたはグループを見つけます。
  2. 左側のサイドバーで、計画 > Wikiを選択します。
  3. Wikiアクション（ ellipsis_v ）を選択し、次にテンプレートを選択します。
  4. 新規テンプレートを選択します。
  5. テンプレートのタイトル、フォーマット、コンテンツを入力します。

テンプレートのパスはタイトルから生成され、編集できません。テンプレートの名前を変更するには、そのタイトルを変更します。タイトルはパスの一部としてのみ保存されるため、テンプレートをページに適用しても、ページコンテンツにタイトルのメタデータは挿入されません。ネストされたテンプレートを作成するには、タイトル内で「/」をパス区切り文字として使用します。

特定の形式のテンプレートは、同じ形式のページにのみ適用できます。たとえば、MarkdownテンプレートはMarkdownページにのみ適用されます。

テンプレートを適用する

Wikiページの作成または編集時にテンプレートを適用できます。

前提条件:

  • テンプレートを少なくとも1つ作成済みであること。
  1. コンテンツセクションで、テンプレートを選択するドロップダウンリストを選択します。
  2. リストからテンプレートを選択します。ページにすでにコンテンツがある場合は、既存のコンテンツが上書きされることを示す警告が表示されます。
  3. テンプレートの適用を選択します。

ページのテンプレートを以前のバージョンに復元する

Wikiページのテンプレートは、履歴から以前のバージョンに復元できます。これにより、完全なバージョン履歴を保持したまま、復元されたコンテンツで新しいバージョンが作成されます。

前提条件:

  • デベロッパー、メンテナー、またはオーナーロールが必要です。

Wikiページのテンプレートを以前のバージョンに復元するには:

  1. 上部のバーで、検索または移動先を選択して、プロジェクトまたはグループを見つけます。
  2. 左側のサイドバーで、計画 > Wikiを選択します。
  3. Wikiアクション（ ellipsis_v ）を選択し、次にテンプレートを選択します。
  4. テンプレートを選択します。
  5. Wikiアクション（ ellipsis_v ）を選択し、次にテンプレートの履歴を選択します。
  6. 復元するバージョンを選択します。
  7. 右上隅で、このバージョンを復元を選択します。
  8. コミットダイアログで、このバージョンを復元する理由を説明するコミットメッセージを追加します。
  9. 復元を選択します。

ページのテンプレートが選択したバージョンに復元されます。以前のすべてのバージョンはページの履歴に残ります。

同じ手順でWikiページを復元することもできます。

Wikiページのサブスクリプション

Wikiページのサブスクリプション機能を使用すると、関心のあるWikiページに変更が加えられたときに通知を受け取ることができます。この機能により、重要なドキュメントの更新について常にチームメンバーに情報を共有し、コラボレーションを強化できます。

特定のWikiページをサブスクライブすると、誰かが次の操作を行ったときに通知を受け取ることができます:

  • ページにコメントを追加する
  • コメントに返信する

Wikiページをサブスクライブする

  1. フォローするWikiページを開きます。
  2. 右上隅で、編集の横にあるベルアイコン（ notifications ）を選択します。
  3. サブスクライブを解除するには、ベルアイコン（ notifications-off ）をもう一度選択します。

サブスクリプションステータスを変更すると、GitLabに確認メッセージが表示されます:

  • サブスクライブした場合、Notifications turned on
  • サブスクライブを解除した場合、Notifications turned off

サブスクリプションの権限

Wikiページを表示するアクセス権を持つすべてのユーザーは、そのページをサブスクライブできます。ユーザーのサブスクリプションステータスは個人用であり、他のユーザーには影響しません。

通知設定

通知はプロジェクトの通知設定に従います。設定済みの通知チャンネルを通じて配信されます。

Wikiページの履歴を表示する

Wikiページの変更履歴は、WikiのGitリポジトリに記録されます。履歴ページには、次の情報が表示されます:

  • ページのリビジョン。
  • ページの作成者。
  • コミットメッセージ。
  • 最終更新。
  • ページバージョン列でリビジョン番号を選択した場合、以前のリビジョン。

Wikiページの変更を表示するには:

  1. 上部のバーで、検索または移動先を選択して、プロジェクトまたはグループを見つけます。
  2. 左側のサイドバーで、計画 > Wikiを選択します。
  3. 履歴を表示するページに移動します。
  4. Wikiアクション（ ellipsis_v ）を選択し、次にページの履歴を選択します。

ページバージョン間の変更点を表示する

バージョン管理された差分ファイルビューと同様に、Wikiページの特定のバージョンで行われた変更を確認できます。

  1. 上部のバーで、検索または移動先を選択して、プロジェクトまたはグループを見つけます。
  2. 左側のサイドバーで、計画 > Wikiを選択します。
  3. 目的のWikiページに移動します。
  4. Wikiアクション（ ellipsis_v ）を選択し、次にページの履歴を選択して、すべてのページバージョンを表示します。
  5. 目的のバージョンについて、差分列でコミットメッセージを選択します。

Wikiページを以前のバージョンに復元する

Wikiページは、履歴から以前のバージョンに復元できます。これにより、完全なバージョン履歴を保持したまま、復元されたコンテンツで新しいバージョンが作成されます。

前提条件:

  • デベロッパー、メンテナー、またはオーナーロールが必要です。

Wikiページを以前のバージョンに復元するには:

  1. 上部のバーで、検索または移動先を選択して、プロジェクトまたはグループを見つけます。
  2. 左側のサイドバーで、計画 > Wikiを選択します。
  3. 復元するページに移動します。
  4. Wikiアクション（ ellipsis_v ）を選択し、次にページの履歴を選択します。
  5. 復元するバージョンを選択します。
  6. 右上隅で、このバージョンを復元を選択します。
  7. コミットダイアログで、このバージョンを復元する理由を説明するコミットメッセージを追加します。
  8. 復元を選択します。

ページは選択したバージョンに復元されます。以前のすべてのバージョンはページの履歴に残ります。

同じ手順でWikiページテンプレートを復元することもできます。

Wikiページには、Wiki内のページの一覧を含むサイドバーが表示されます。この一覧はネストされたツリーとして表示され、同じ階層のページはアルファベット順に表示されます。

サイドバーの検索ボックスを使用して、Wiki内のページをタイトルで検索できます。ページの左上隅にあるサイドバー切替（ sidebar ）を使用して、サイドバーを開閉できます。

パフォーマンス上の理由から、サイドバーに表示できるエントリは5,000件に制限されています。すべてのページの一覧を表示するには、サイドバーですべてのページを表示を選択します。

サイドバーをカスタマイズする

サイドバーのナビゲーションの内容は手動で編集できます。

前提条件:

  • デベロッパー、メンテナー、またはオーナーロールが必要です。

このプロセスでは、_sidebarという名前のWikiページが作成され、デフォルトのサイドバーナビゲーションが完全に置き換えられます。

  1. 上部のバーで、検索または移動先を選択して、プロジェクトまたはグループを見つけます。
  2. 左側のサイドバーで、計画 > Wikiを選択します。
  3. ページの左上隅で、カスタムサイドバーを追加する（ settings ）を選択します。
  4. 完了したら、変更を保存を選択します。

Markdown形式の_sidebarの例:

### Home

- [Hello World](hello)
- [Foo](foo)
- [Bar](bar)

---

- [Sidebar](_sidebar)

プロジェクトWikiを有効または無効にする

GitLabでは、Wikiはデフォルトで有効になっています。プロジェクトの管理者は、共有と権限の手順に従って、プロジェクトWikiを有効または無効にできます。

GitLab Self-Managedの管理者は、追加のWiki設定を行えます。

グループ設定からグループWikiを無効化できます。

プロジェクトの左側のサイドバーから外部Wikiへのリンクを追加するには:

  1. 上部のバーで、検索または移動先を選択して、プロジェクトを見つけます。
  2. 左側のサイドバーで、設定 > インテグレーションを選択します。
  3. 外部Wikiを選択します。
  4. 外部WikiのURLを追加します。
  5. オプション。テスト設定を選択します。
  6. 変更を保存を選択します。

これで、プロジェクトの左側のサイドバーに外部Wikiオプションが表示されます。

このインテグレーションを有効にしても、外部Wikiへのリンクで内部Wikiへのリンクが置き換えられることはありません。サイドバーから内部Wikiを非表示にするには、プロジェクトのWikiを無効にします。

外部Wikiへのリンクを非表示にするには:

  1. 上部のバーで、検索または移動先を選択して、プロジェクトを見つけます。
  2. 左側のサイドバーで、設定 > インテグレーションを選択します。
  3. 外部Wikiを選択します。
  4. インテグレーションを有効にするで、有効チェックボックスをオフにします。
  5. 変更を保存を選択します。

プロジェクトのWikiを無効にする

プロジェクトの内部Wikiを無効にするには:

  1. 上部のバーで、検索または移動先を選択して、プロジェクトを見つけます。
  2. 左側のサイドバーで、設定 > 一般を選択します。
  3. 可視性、プロジェクトの機能、権限を展開します。
  4. 下にスクロールして、Wiki切替をオフ（グレー）にします。
  5. 変更を保存を選択します。

これで内部Wikiが無効になり、ユーザーとプロジェクトメンバーは次の操作ができなくなります。

  • プロジェクトのサイドバーからWikiへのリンクを見つける。
  • Wikiページを追加、削除、または編集する。
  • Wikiページを表示する。

以前に追加されたWikiページは、Wikiを再度有効にする場合に備えて保持されます。再度有効にするには、Wikiを無効にする手順を繰り返し、切替をオン（青）にします。

リッチテキストエディタ

GitLabでは、WikiでGitLab Flavored Markdownのリッチテキスト編集を利用できます。

サポートには次のものが含まれます:

  • 太字、斜体、ブロック引用、見出し、インラインコードなどを使用したテキストの書式設定。
  • 順序付きリスト、順序なしリスト、チェックリストの書式設定。
  • テーブル構造の作成と編集。
  • 構文ハイライトによるコードブロックの挿入と書式設定。
  • Mermaid、PlantUML、Krokiの図のプレビュー。

リッチテキストエディタを使用する

  1. 新しいWikiページを作成するか、既存のWikiページを編集します。
  2. フォーマットとしてMarkdownを選択します。ページオプションを編集（ chevron-down ）をエディタヘッダーで選択し、フォーマットを変更します。
  3. エディタのヘッダーで、リッチテキスト編集に切り替えるを選択します。
  4. リッチテキストエディタで使用できる各種書式設定オプションを使用して、ページのコンテンツをカスタマイズします。
  5. 新しいページの場合はページを作成を選択し、既存のページの場合は変更を保存を選択します。

プレーンテキストに戻すには、テキスト編集に切り替えるを選択します。

関連トピック:

GitLab Flavored Markdownのサポート

リッチテキストエディタですべてのGitLab Flavored Markdownコンテンツタイプをサポートする作業が進行中です。CommonMarkおよびGitLab Flavored Markdownサポートに関する開発状況については、以下を参照してください:

Wikiイベントを追跡する

GitLabはWikiの作成、削除、更新イベントを追跡します。これらのイベントは、次のページに表示されます。

Wikiへのコミットはリポジトリ分析にはカウントされません。

トラブルシューティング

Apacheリバースプロキシによるページslugのレンダリング

ページslugは、ERB::Util.url_encodeメソッドを使用してエンコードされます。Apacheリバースプロキシを使用する場合は、Apache設定のProxyPass行にnocanon引数を追加すると、ページslugを正しくレンダリングできます。

RailsコンソールでプロジェクトWikiを再作成する

  • プラン: Free、Premium、Ultimate
  • 提供形態: GitLab Self-Managed、GitLab Dedicated

この操作により、Wiki内のすべてのデータが削除されます。

データを直接変更するコマンドは、正しく実行されなかった場合、または適切な条件下で実行されなかった場合、損害を与える可能性があります。念のため、復元できるインスタンスのバックアップを用意したうえで、テスト環境で実行することを強くおすすめします。

プロジェクトWikiのすべてのデータを消去し、空の状態で再作成するには:

  1. Railsコンソールセッションを開始します。

  2. 次のコマンドを実行します:

    # Enter your project's path
p = Project.find_by_full_path('<username-or-group>/<project-name>')

# This command deletes the wiki project from the filesystem.
p.wiki.repository.remove

# Refresh the wiki repository state.
p.wiki.repository.expire_exists_cache

Wikiのすべてのデータが消去され、Wikiを使用できる状態になります。