Wiki固有のMarkdown
- プラン: Free、Premium、Ultimate
- 提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated
リンク
次のトピックでは、Wiki内のリンクの動作について説明します。
Wikiページにリンクする場合、ページ名ではなくページslugを使用してください。ページslugは、ページのタイトルをURLフレンドリーにしたバージョンで、スペースがハイフンに置き換えられ、特殊文字が削除または変換されています。例えば、「How to Use GitLab」というタイトルのページには、slug How-to-Use-GitLabがあります。
Wikiスタイルのリンク
標準のMarkdownリンクに加えて、Wikiは特別なWikiスタイルリンク構文をサポートしており、Wikiページ間のリンクをより便利にする方法を提供します。
二重角かっこ構文
二重角括弧を使用してWikiページにリンクできます:
[[Home]]この構文は、slug Homeを持つWikiページへのリンクを作成します。そのページが存在しない場合、リンクを選択すると、そのページを作成できます。
ページslugにハイフンが含まれている場合、リンクはslugをそのまま表示します:
[[Home-page-new-slug]]これはHome-page-new-slugをリンクテキストとして表示します。
カスタムテキスト付き二重角かっこ構文
ページslugが表示したいタイトルと異なる場合は、パイプ(|)文字を使用して表示テキストをページslugから区切ります:
[[How to use GitLab|how-to-use-gitlab]]これは「How to use GitLab」をリンクテキストとして表示しますが、slug how-to-use-gitlabを持つページにリンクします。
この構文を使用して、ハイフンを含むslugを持つページのタイトルをより読みやすくすることもできます:
[[Home page (renamed)|Home-page-new-slug]]これは「Home page (renamed)」をリンクテキストとして表示しますが、slug Home-page-new-slugを持つページにリンクします。
代替Wikiページ構文
[wiki_page:PAGE_SLUG]構文を使用することもできます:
[wiki_page:Home]クロスプロジェクト参照の場合は、完全なプロジェクトパスを指定します:
[wiki_page:namespace/project:Home]
[wiki_page:group1/subgroup:Home]自動URL認識
MarkdownフォーマットなしでWikiページに完全なURLを貼り付けると、GitLabは自動的にそれをリンクに変換し、ハイフンの代わりにスペースでページslugを表示します:
https://gitlab.com/namespace/project/-/wikis/Home-page-new-slugこれは「Home page new slug」(ハイフンがスペースに変換されたもの)というテキストのリンクとして自動的にレンダリングされます。
直接ページリンク
ダイレクトページリンクには、Wikiのベースレベルで、そのページを指すページのslugが含まれます。
この例は、Wikiのルートにあるdocumentationページにリンクしています。
[Link to Documentation](documentation-top-page)直接ファイルリンク
ダイレクトファイルリンクは、現在のページを基準にして、ファイルのファイル拡張子を指します。
次の例が<your_wiki>/documentation/relatedのページにある場合、<your_wiki>/documentation/file.mdにリンクします。
[Link to File](file.md)階層リンク
階層リンクは、./<page>や../<page>のような相対パスを使用して、現在のWikiページを基準に構築できます。
この例が<your_wiki>/documentation/mainのページにある場合、<your_wiki>/documentation/relatedにリンクします。
[Link to Related Page](related)この例が<your_wiki>/documentation/related/contentのページにある場合、<your_wiki>/documentation/mainにリンクします。
[Link to Related Page](../main)この例が<your_wiki>/documentation/mainのページにある場合、<your_wiki>/documentation/related.mdにリンクします。
[Link to Related Page](related.md)この例が<your_wiki>/documentation/related/contentのページにある場合、<your_wiki>/documentation/main.mdにリンクします。
[Link to Related Page](../main.md)ルートリンク
ルートリンクは、/で始まり、Wikiルートを基準にしています。
この例は、<wiki_root>/documentationにリンクしています。
[Link to Related Page](/documentation)この例は、<wiki_root>/documentation.mdにリンクしています。
[Link to Related Page](/documentation.md)diagrams.net editor
Wikiでは、diagrams.netエディタを使用して図を作成できます。diagrams.netエディタで作成した図を編集することもできます。図エディタは、プレーンテキストエディタとリッチテキストエディタの両方で使用できます。
詳細については、Diagrams.netを参照してください。
プレーンテキストエディタ
次の手順により、プレーンテキストエディタで図を作成できます。
- 編集するWikiページで編集を選択。
- テキストボックスで、プレーンテキストエディタを使用していることを確認(左下のボタンにリッチテキスト編集に切り替えると表示されます)。
- エディタのツールバーで図の挿入または編集( )を選択。
- app.diagrams.netエディタで図を作成。
- 保存して終了を選択。
図へのMarkdown画像参照がWikiコンテンツに挿入されます。
次の手順により、プレーンテキストエディタで図を編集できます。
- 編集するWikiページで編集を選択。
- テキストボックスで、プレーンテキストエディタを使用していることを確認(左下のボタンにリッチテキスト編集に切り替えると表示されます)。
- 図を含むMarkdown画像参照内にカーソルを合わせる。
- 図の挿入または編集( )を選択。
- app.diagrams.netエディタで図を編集。
- 保存して終了を選択。
図へのMarkdown画像参照がWikiコンテンツに挿入され、前の図が置き換えられます。
リッチテキストエディタ
次の手順により、リッチテキストエディタで図を作成できます。
- 編集するWikiページで編集を選択。
- テキストボックスで、リッチテキストエディタを使用していることを確認します(左下のボタンにプレーンテキスト編集に切り替えると表示されます)。
- エディタのツールバーでその他のオプション( )を選択。
- ドロップダウンリストで図の作成または編集を選択。
- app.diagrams.netエディタで図を作成。
- 保存して終了を選択。
diagrams.netエディタで視覚化された図がWikiコンテンツに挿入されます。
次の手順により、リッチテキストエディタで図を編集できます。
- 編集するWikiページで編集を選択。
- テキストボックスで、リッチテキストエディタを使用していることを確認します(左下のボタンにプレーンテキスト編集に切り替えると表示されます)。
- 編集する図を選択。
- フローティングツールバーで図の編集( )を選択。
- app.diagrams.netエディタで図を編集。
- 保存して終了を選択。
選択した図が更新されたバージョンに置き換えられます。