Wiki 編集ガイド

Markdown の書き方・Frontmatter の設定方法・使えるショートコードをまとめます。

Wiki 編集ガイド

Frontmatter の書き方

各 Markdown ファイルの先頭に TOML 形式のメタデータ(Frontmatter)を記述します。

+++
title = "ページタイトル"          # 必須
description = "概要(検索・OGP用)"
date = 2026-04-16                  # 必須(作成日)
updated = 2026-04-16               # 更新日(編集時に更新推奨)
authors = ["Yamada Taro"]
tags = ["ros2", "navigation"]      # 複数設定可
category = "knowledge"             # 必須: onboarding/research/knowledge/projects/meeting
draft = false
weight = 0                         # サイドバー表示順(小さい値が上)

[extra]
related = ["knowledge/git-workflow"]   # 関連ページのパス
+++

Markdown チートシート

見出し

# H1(ページタイトルに自動使用されるため本文では非推奨)
## H2(目次に表示)
### H3(目次に表示)
#### H4(目次に表示)

コードブロック

```python
def hello():
    print("Hello, SCR Lab!")
```

テーブル

| 列1 | 列2 | 列3 |
|---|---|---|
| A | B | C |

内部リンク

[環境構築ガイド](../onboarding/environment-setup)

Callout ショートコード

<div class="callout callout--info" role="note">
  
  <div class="callout__header">
    <span class="callout__icon" aria-hidden="true">
      ℹ️
    </span>
    <span class="callout__title">情報タイトル</span>
  </div>
  
  <div class="callout__body">
    本文テキスト
  </div>
</div>

利用可能な type: info / warning / danger / tip

info の例
これは情報ボックスです。補足情報や参考リンクに使用します。
warning の例
注意が必要な事項に使用します。
tip の例
ベストプラクティスや Tips に使用します。
danger の例
重要な警告・データ消失リスクなどに使用します。