リファレンスパイプライン常緑更新 2026.08読了目安 7 分
リファレンス · Markdown パイプラインの実演

全部入りデモ

このサイトの Markdown パイプラインの全要素が、このページで一度ずつ演じられます:インライン記法、ウィキリンク、カードに変わるテーブル、三通りの書き方のコールアウト、数式、コードフレーム、図、絵文字ショートコード、GFM の追加機能——上の帯にある読了目安もパイプラインの仕事です。このページがそもそもビルドを通ること自体が実演です:コンテンツガードは巻末に列挙した壊れた書き方をすべて拒むので、いま見えているものは方言が受理したものだけです。このサイトが切っている二つのスイッチ——番号付けプリセット sections とサブパスの base 接頭辞——はガイドに説明があります。

4 部 · このサイトが入れている全スイッチ · ガードの拒否リストは巻末に

PART Iテキスト

§1.1インライン記法

強調の解析は CJK フレンドリーです:太字は中国語の句読点に接しても閉じます——**报文。**同时报文。同时 と描画され、生のアスタリスクにはなりません。斜体打ち消し線インラインコード は通常どおり。gemoji スイッチを入れれば、:sparkles: のようなショートコードが ✨ に描画されます。インラインコードの中の文字は一切の解析に参加しないので、構文を見せるときはバッククォートが安全です:**$…$> [!note] も、字面のまま現れます。本文中でアスタリスクそのものを見せたいときはエスケープを——*こう書けば*ただの文字のままです。

§1.2ウィキリンク

wikilinks スイッチが入っていると、[[二重ブラケット]] のリンクは wiki の流儀でノート集に対して解決されます:id で(design-tokens——日本語ミラーのページから辿れば同じ言語のミラーが先に解決され、無いときだけ英語の原本に落ちます)、別名で(boundaries は id が three-way-split のノートに届きます)、ラベル付きで(はじめにガイド)。[[id#見出し]] の形でアンカーも指せます。解決できないターゲットはビルドを落とさず、死リンクの印付きで描画されます——リンクの腐敗は CI の check-wikilinks が報告します。それが本来の持ち場です。

§1.3テーブル:広ければスクロール、狭ければカード

6 列以上のテーブルは、狭いコンテナでは各セルを 2 文字幅に潰すのではなく、1 行を 1 枚のカードに流し直すべきです。この 7 列のテーブルはコールアウトのバリアント早見表であると同時に、その変形の生きたテストでもあります(ウィンドウをスマホ幅まで縮めてみてください):

バリアントクラス引用構文のキーワード枠線既定タイトル典型的な用途
notecalloutnote info赭(オーカー)--color-accent3数式の地 --color-math-bgNote中立な補足
intuitioncallout intuitiontip intuition hint黛(ティール)--color-accent2数式の地Intuition直感を育てる類比
warncallout warnwarn warning caution danger石(バーントオレンジ)--color-accentアクセント 8% 混色Warning危ない手順の前の注意
systemcallout systemimportant system紫(バイオレット)--color-accent4紫 8% 混色Importantシステムレベルの約束事
abstractcallout abstractabstract summary quote淡墨 --color-ink-faint柔らかい面 --color-bg-softAbstract章頭の要約
badcallout bad(生 HTML のみ)石(バーントオレンジ)アクセント 10% 混色記録された失敗、退けられた設計

既定タイトルは英語です。サイトは siteMarkdowncalloutLabels オプションで一式まるごと差し替えます。たとえば calloutLabels: { tip: '直感 · Intuition' }。引用構文で書いたタイトル(> [!tip] 自分のタイトル)が常に優先されます。

PART IIコールアウトと数式

§2.1コールアウト:三通りの書き方

第一は、Obsidian/GitHub の引用構文(callouts: true で使え、純 Markdown ファイルでも書けます):

Obsidian の折りたたみ記号も効きます——> [!note]- は畳んだ状態で、> [!note]+ は開いた状態で描画されます:

畳まれたノート

タイトルをクリックすると開きます。畳まれたコールアウトは <details> として描画され、タイトルがその <summary> になります。

第二は、MDX でのパッケージコンポーネント(astro-inkstone/components/Callout.astro、パスで import)。title を渡さなければ、バリアント既定のラベル——引用構文と同じもの——が出ます:

第三は生 HTML、六つのバリアントを一気に(base.css.callout 規則と一対一対応):

Note
中立の傍注。無修飾の .callout クラスがちょうどこれです。

直感 · Intuition
黛(ティール)の左端。それが何かではなくどう考えればよいかを語る段落に。

注意 · Warning
バーントオレンジの左端、アクセント 8% の地——失敗しうる手順の前に現れます。

システム · System
バイオレットの左端。システムレベルの約束事に:変える前に、それがなぜあるのかを理解してください。

要旨 · Abstract
柔らかい面の上に淡墨の縁。章の頭に置く素早い見取り図に。

反例 · Bad
失敗と退けられた実装の記録。このバリアントがなければ、「これは間違いだ」という事実は音もなく失われます。

§2.2数式

インライン数式は本文に座ります:光学的厚みは τ=κρds\tau = \int \kappa \rho \, \mathrm{d}s と読めます。ディスプレイ数式は三行形($$ をそれぞれ単独の行に)——一行形はガードが拒みます。小さなインライン数式として音もなく描画されてしまうからです:

01x2dx=13\int_0^1 x^2 \, \mathrm{d}x = \frac{1}{3}

数式の地は本文の紙とは意図的に別の紙で、テーマとともに切り替わります。ついでに、本文中のドル価格はエスケープを:このコーヒーは $3 です。

PART IIIコードと図

§3.1コードフレーム

title="…" を付けたフェンスにはファイル名のタイトルバーが付きます。隅のコピーボタンはサイト全体で共通。[!code ++] / [!code --] の行アノテーションは diff の地として描画されます:

pipeline.py
def build_pipeline(opts):
    plugins = [remark_math]  
    plugins = [remark_gemoji, remark_math]  
    return assemble(plugins, guard=opts.guard)

collapse と印を付けたフレームは畳まれた状態で始まり、開いたときだけ場所を取ります——長い設定ファイルにちょうどいい:

inkstone.example.yamlExpandCollapse
yaml
site:
  markdown:
    numbering: chapters
    math: true
    codeFrame: true
    mermaid: true
    callouts: true
    wikilinks: true
  styles:
    - astro-inkstone/styles/tokens.css
    - astro-inkstone/styles/base.css

二重テーマのハイライトは、shiki が両方の色セットを一度に出力することで得ています。base.cssdata-theme を見て一箇所で選ぶだけ——詳細度の綱引きはありません。

§3.2mermaid の図

```mermaid フェンスは、ビルド時にはプレースホルダだけを残します。レンダラは図を載せたページでだけ動的に読み込まれ(図のないページは何も払いません)、テーマが切り替われば描き直します:

flowchart LR
  A["astro-inkbrush<br/>エンジン:編集 / 方言 / ガード"] --> C["あなたのサイト<br/>アイデンティティ / ルーティング / デプロイ"]
  B["astro-inkstone<br/>紙面:トークン / スタイル / パイプライン"] --> C
  A -. 方言は同じ一つ .-> B

§3.3GFM の追加機能

タスクリストと脚注は GFM と一緒に付いてきます:

  • tokens をインポートした
  • base.css をインポートした
  • アイデンティティのパレットを上書きした

出典を付ける価値のある主張には脚注を。1

PART IVガード

§4.1このページでガードが拒むもの

このページがビルドを通ること自体が、上のすべてが整形式であることの証明です。次の書き方は、その場でビルドを落とします(試すなら、書き換えてから npm run build を):

  • 対を作れない強調マーカー。たとえば行末で閉じ損ねた **
  • 一行の $$x$$(三行形を使うこと)。
  • 見出しへの手書き番号——本節の見出しを ## 9. このページで… と書けば、ビルド時の自動番号と衝突して検出されます。
  • MDX に本文の波括弧を評価されること:{0,1,2,3} はページ上ではただの 3 になるので、ガードはエスケープ形 {0,1,2,3} を要求します。
  • KaTeX が描画できない数式(ガードは赤いエラーテキストを出荷せず、全数式を strict モードで実際に描画し直して確かめます)。

Footnotes

  1. 脚注はページの足元に、戻りリンク付きで描画されます。スタイルは本文レイヤーのものです。

タイトル・見出し・本文を、この言語内で検索します。
    ↑↓ · Enter · Escastro-inkstone