Wiki固有のMarkdown
- プラン: Free、Premium、Ultimate
- 提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated
リンク
次のトピックでは、Wiki内のリンクの動作について説明します。
Wikiページにリンクする場合は、ページ名ではなく、ページslugを使用してください。ページslugとは、URLフレンドリーなバージョンのページタイトルで、スペースがハイフンに置き換えられ、特殊文字が削除または変換されます。たとえば、「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]]これは、リンクテキストとして「GitLabの使用方法」を表示しますが、slugがhow-to-use-gitlabのページにリンクします。
この構文を使用して、ハイフンで区切られたslugを持つページに対して、より読みやすいタイトルを提供することもできます:
[[Home page (renamed)|Home-page-new-slug]]これは、リンクテキストとして「ホームページ (名前変更)」を表示しますが、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エディタ
Wikiでは、diagrams.netエディタを使用して図を作成できます。diagrams.netエディタで作成した図を編集することもできます。図エディタは、プレーンテキストエディタとリッチテキストエディタの両方で使用できます。
詳細については、Diagrams.netを参照してください。
プレーンテキストエディタ
次の手順により、プレーンテキストエディタで図を作成できます:
- 編集するWikiページで編集を選択。
- テキストボックスで、プレーンテキストエディタを使用していることを確認(左下のボタンにリッチテキスト編集に切り替えると表示されます)。
- エディタのツールバーでダイアグラムの挿入または編集( )を選択。
- app.diagrams.netエディタで図を作成。
- Save & exit(保存して終了)を選択。
図へのMarkdown画像参照がWikiコンテンツに挿入されます。
次の手順により、プレーンテキストエディタで図を編集できます:
- 編集するWikiページで編集を選択。
- テキストボックスで、プレーンテキストエディタを使用していることを確認(左下のボタンにリッチテキスト編集に切り替えると表示されます)。
- 図を含むMarkdown画像参照内にカーソルを合わせる。
- エディタのツールバーでダイアグラムの挿入または編集( )を選択。
- app.diagrams.netエディタで図を編集。
- Save & exit(保存して終了)を選択。
図へのMarkdown画像参照がWikiコンテンツに挿入され、前の図が置き換えられます。
リッチテキストエディタ
次の手順により、リッチテキストエディタで図を作成できます:
- 編集するWikiページで編集を選択。
- テキストボックスで、リッチテキストエディタを使用していることを確認します(左下のボタンにテキスト編集に切り替えると表示されます)。
- エディタのツールバーでその他のオプション( )を選択。
- ドロップダウンリストでダイアグラムの作成または編集を選択。
- app.diagrams.netエディタで図を作成。
- Save & exit(保存して終了)を選択。
diagrams.netエディタで視覚化された図がWikiコンテンツに挿入されます。
次の手順により、リッチテキストエディタで図を編集できます:
- 編集するWikiページで編集を選択。
- テキストボックスで、リッチテキストエディタを使用していることを確認します(左下のボタンにテキスト編集に切り替えると表示されます)。
- 編集する図を選択。
- フローティングツールバーでダイアグラムの編集( )を選択。
- app.diagrams.netエディタで図を編集。
- Save & exit(保存して終了)を選択。
選択した図が更新されたバージョンに置き換えられます。