ストラボのMarkdown記法一覧
このページでは、ストラボで使えるMarkdown記法を一覧で紹介します。
0. 執筆のポイント
ストラボでは、 Markdown(マークダウン)
を使って記事を執筆します。
以下のポイントに注意して、読みやすく、分かりやすい記事を作成しましょう。
具体的な記法は次のセクションから説明します。
- H2 見出し でセクションを分ける
- 見出しは 簡潔 & 連番 に
- 箇条書きは H3 見出し で分ける
- アドモニション は適切な種類を選ぶ
- テーブル に詰め込みすぎない
- 数式 は KaTeX を使用
- テーブル や 数式 は AIに書いてもらうと便利
- コードブロック は言語を指定してハイライト
- 画像 は適切なサイズで挿入
- 脚注 は必要な場合のみ使用
- 太字・色 は使い過ぎない (アクセシビリティ)
1. 基本構文
1.1 見出し
## H2 見出し
### H3 見出し
ストラボでは記事タイトルが自動で H1 になるため、本文は H2 から使うのが推奨です。
1.2 段落 & 改行
空行 1 行 で段落区切り、 行末に半角スペース×2 で明示的改行 になります。
1.2.1 段落を分ける
これは 1 つ目の段落です。
これは 2 つ目の段落です。
【出力例(段落)】
これは 1 つ目の段落です。
これは 2 つ目の段落です。
1.2.2 行末 2 スペースによる改行
行末に半角スペースを2つ入れると··
ここで改行されます。
【出力例(改行)】
行末に半角スペースを2つ入れると··
ここで改行されます。
1.3 強調
_イタリック_
**ボールド**
~~取り消し線~~
【出力例】
イタリック
ボールド
取り消し線
1.4 リンク
[ストラボ](https://structurebox.example.com)
【出力例】
1.5 引用
> 引用文をここに書く
【出力例】
引用文をここに書く
1.6 グレー背景の強調
`グレー背景の強調`
【出力例】
グレー背景の強調
1.7 水平線
---
【出力例】
2. リスト
- 箇条書き
- ネスト
1. 番号付き
2. リスト
【出力例】
- 箇条書き
- ネスト
- 番号付き
- リスト
3. 画像とキャプション
通常:

【出力例】
4. テーブル 【AI代筆推奨】
| TH1 | TH2 |
| --- | --- |
| TD1 | TD2 |
【出力例】
見出しA | 見出しB |
---|---|
1 行目 | 内容 |
2 行目 | 内容 |
5. コードブロック & ハイライト
コードは 「```」
で挟むことでブロックとして記載できます。
言語を指定するとコードへ装飾(シンタックスハイライト)が適用されます。
```ts
// TypeScript
const hello = (name: string): void => {
console.log(`Hello ${name}`)
}
```
【出力例】
// TypeScript
const hello = (name: string): void => {
console.log(`Hello ${name}`)
}
6. Hide タグ
文章中の強調注釈として <Hide>テキスト</Hide>
を使うとグレーでマスク表示され、クリックで展開されます。
これは <Hide>ネタバレ</Hide> を隠す例です。
【出力例】
これは ??? を隠す例です。
7. アドモニション
アドモニション
の 書き方 と 出力例 を 1 セットで示します。
note
はブルー系、info
はオレンジ系、tip
はグリーン系、warning
はイエロー系、danger
はレッド系で表示されます。
7.1 note [概要]
:::note
これは note の例です。
:::
これは note の例です。
7.2 info [情報]
:::info
これは info の例です。
:::
これは info の例です。
7.3 tip [ヒント]
:::tip
これは tip の例です。
:::
これは tip の例です。
7.4 warning [注意]
:::warning
これは warning の例です。
:::
これは warning の例です。
7.5 danger [警告]
:::danger
これは danger の例です。
:::
これは danger の例です。
8. 数式 (KaTeX) 【AI代筆推奨】
数式は KaTeX
を使って記述できます。
画像などをAIに 「この画像の数式をKaTeXで書いて」
と頼むと、出力してくれます。
8.1 インライン数式
インライン数式の書き方:
`$E = mc^2$`
【出力例】
8.2 ブロック数式
ブロック数式の書き方:
$$
Q = aA \sqrt{\frac{2 g h (t_i - t_o)}{t_i + 273}}
$$
【出力例】
9. 脚注
脚注の例 [^1]
[^1]: 下部に表示される注釈
【出力例】
脚注は記事の下部に表示されます。
脚注の例 1
Footnotes
-
下部に表示される注釈 ↩