@kappan/plugin-figure-numbering

図・表・リスト・節・数式・章の自動採番と相互参照解決プラグイン。Pandoc-crossref 互換の参照記法をサポートする。

• ![alt](path){#fig:id} → 単独段落のブロック画像を <figure><figcaption>図1.1: alt</figcaption></figure> に変換し、番号付きキャプションを可視で出す
• GFM テーブル／コードブロック ＋ 直前/直後の {#tbl:id}／{#lst:id} キャプション段落 → <figure> で包み「表1.1: …」「リスト1.1: …」を表示
• ## 節 {#sec:id} / $$..$$ 直後の {#eq:id} → 節・数式を採番
• [@fig:id] 等 → 番号付きラベル（図1.1 など）のハイパーリンクに解決。章をまたぐ参照は [@fig:ch03/id]、章自体は [@chap:ch03]。未定義の参照はビルド時に警告

Installation

pnpm add @kappan/plugin-figure-numbering

Usage

import { defineConfig } from '@kappan/core';
import { figureNumbering } from '@kappan/plugin-figure-numbering';

export default defineConfig({
  // ...
  plugins: [figureNumbering()],
});

Markdown Example

# 第1章 構成

![システム構成図](arch.png){#fig:arch}

[@fig:arch] のとおり、3 階層で構成される。

出力：

• 画像が <figure id="fig-arch"> で包まれ、キャプション「図1.1: システム構成図」が図の下に表示される（alt は素の説明「システム構成図」のまま）
• 本文の [@fig:arch] が「図1.1」へのリンク（<a href="#fig-arch" class="kappan-xref">）に

比較表 {#tbl:cmp}

| 項目 | A   | B   |
| ---- | --- | --- |
| 速度 | 速  | 遅  |

表の直前（または直後）に {#tbl:id} を含む段落を置くと、その表が <figure> で包まれ 「表1.1: 比較表」のキャプションが付く。

Options

figureNumbering({
  labelStyle: 'jp', // 'jp' (図1.1) | 'en' (Fig.1.1)
});

Reference Notations

すべて解決後はアンカーへのハイパーリンクになる。

| 記法 | 種別 | | ---------------- | -------------- | | [@fig:id] | 図 | | [@tbl:id] | 表 | | [@lst:id] | リスト | | [@sec:id] | 節 | | [@eq:id] | 数式 | | [@chap:ch03] | 章 | | [@fig:ch03/id] | 他章の図表・節 |

Documentation

• Kappan リポジトリ
• Pandoc-crossref

License

MIT