GitLab の Markdown で使える記法のあれこれ

この記事は GitLab Advent Calendar 2025 の17日目のエントリーです。

Advent Calendar ももう17日目、12月も折り返し地点を超えました！時間が過ぎるのは早いですね、17日目だから余裕だろうと思っていたら、いつの間にか17日目です！！

GitLab 好きな方は、普段から Issue, Merge Request, Wiki などいろいろなところで Markdown を利用されているかと思いますが、最近では更に、生成AIを活用する中で色んなものを Markdown で管理することが増えてきています。
この記事では GitLab で使えるMarkdown 記法ネタを扱ってみたいと思います

GitLab Flavored Markdown とは？

GitLab UI での GitLab Flavored Markdown(GLFM) として Markdown が扱われます。GFLM と標準の Markdown の違いとして、以下のような機能があります。

1. CommonMark 仕様に基づいた Core Markdown 機能
2. GitHub Flavored Markdown からの拡張機能
3. GitLab 専用に作成された拡張機能

埋め込みビューでのリアルタイムの可視性とレポート

18.3からGitLab Query Language (GLQL) を利用した埋め込みビューが利用できるようになりました！
朝会向けのWikiに埋め込んだみたり、リリースに関連するものを一覧化してみたり、動的ビューをページに埋め込むことで、プロジェクトの進行状況をリアルタイムに確認できます

```glql
display: table
query: assignee = currentUser()
fields: title, state, createdAt, assignee
title: 現在のユーザーにアサインされたイシュー
```

参考情報：GitLab Query Language (GLQL)

Alerts - 「ここ大事！」を目立たせる

手順やマニュアルを Wiki や Markdown で管理することもあるかと思いますが、特に注意喚起を促したいときには、Alerts を使うのが便利です！

```
> [!NOTE]
> これは覚えておくべき重要な情報です

> [!WARNING]  
> この操作は注意が必要です
```

ダイアグラムとフローチャートのあれこれ

最近だと設計書をMarkdown形式で管理することも増えてきたかと思いますが、処理設計についてはテキストや表だけだとイメージしにくいことも結構ありますよね？
そんな時は、ぜひMermaidやPlantUMLでのフローの可視化をご活用ください！

```mermaid
graph TB
    subgraph クライアント層
        Browser[Webブラウザ]
    end
    
    subgraph ネットワーク層
        LB[ロードバランサー<br/>Nginx/ALB]
    end
    
    subgraph アプリケーション層
        API1[APIサーバー #1<br/>Node.js/Rails]
        API2[APIサーバー #2<br/>Node.js/Rails]
        API3[APIサーバー #3<br/>Node.js/Rails]
    end
    
    subgraph データ層
        PostgreSQL[(PostgreSQL<br/>ユーザーDB)]
    end
    
    Browser -->|HTTPS| LB
    
    LB --> API1
    LB --> API2
    LB --> API3
    
    API1 --> PostgreSQL
    API2 --> PostgreSQL
    API3 --> PostgreSQL
```

```plantuml
@startuml
actor User
participant "Web Browser" as Browser
participant "API Gateway" as API
participant "Auth Service" as Auth
database "User DB" as DB

User -> Browser: ログイン情報入力
Browser -> API: POST /api/login
API -> Auth: 認証リクエスト
Auth -> DB: ユーザー検証
DB --> Auth: ユーザー情報
Auth --> API: JWT トークン生成
API --> Browser: トークン返却
Browser --> User: ログイン成功

@enduml
```

ここら辺は、Qiitaでもサポートされているので、みなさんお馴染みですね！

まとめ

今回はGitLabで利用できるMarkdownのGitLab Flavored Markdown (GLFM)について紹介させてもらいました。
生成AIへのインプット、アウトプットとしてMarkdownを利用する機会が増えているかと思うので、これまでMarkdownをあまり使ってこなかった人もぜひこの機にMarkdownを使い始めてみてください

参考情報：GitLab Flavored Markdown (GLFM)