@riebeckite/plugin-markmap 0.0.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright Rerurate_514
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,140 @@
+# @riebeckite/plugin-markmap
+
+Renders ` ```markmap ` code blocks as Markdown-heading mindmaps. The mindmap is
+drawn in the browser by `markmap-lib` + `markmap-view`, which are imported from
+the CDN only when a figure is present.
+
+[Japanese](./README_ja.md)
+
+## Configure
+
+```ts
+import { defineConfig } from "@riebeckite/core";
+import { markmap } from "@riebeckite/plugin-markmap";
+
+export default defineConfig({
+  // ...
+  plugins: [
+    markmap({
+      caption: true,
+      height: 320,
+      fallback: true,
+    }),
+  ],
+});
+```
+
+The plugin runs with `order: -10`.
+
+## Syntax
+
+The block body is ordinary Markdown: headings become nodes and their nesting
+becomes the tree. Content other than headings is ignored.
+
+````markdown
+```markmap
+# Project
+
+## Design
+
+### Notation
+### Rendering
+
+## Delivery
+```
+````
+
+The caption comes from the code-block `title`.
+
+## How it renders
+
+A ` ```markmap ` block becomes a `figure.rb-markmap`:
+
+- `figure.rb-markmap`: carries `data-markmap="pending"`,
+  `data-markmap-source` (the raw Markdown) and `data-markmap-height`
+- `div.rb-markmap__canvas`: the element the SVG is rendered into
+  (`role="img"`)
+- `figcaption.rb-markmap__caption`: the caption (enabled by default)
+- `details.rb-markmap__fallback`: the raw Markdown, folded away
+
+`initMarkmap` finds every `[data-markmap="pending"]`, loads the runtime, runs
+`markmap-lib`'s `Transformer` over `data-markmap-source`, and renders the
+resulting tree with `markmap-view`'s `Markmap.create`. On success the figure
+becomes `data-markmap="rendered"`.
+
+If loading the runtime, transforming the source, or rendering fails, the
+initializer does not throw: it opens that figure's `details` and marks it
+`data-markmap="error"`.
+
+A block whose body has no Markdown heading is left as a normal code block, and a
+diagnostic with `source: "@riebeckite/plugin-markmap"` is emitted.
+
+## Options
+
+| Option | Default | Description |
+| --- | --- | --- |
+| `caption` | `true` | Show the code-block `title` as a caption |
+| `height` | `320` | Canvas height in pixels |
+| `className` | `"rb-markmap"` | Base class applied to the figure |
+| `language` | `"markmap"` | Fenced-code language to recognize |
+| `fallback` | `true` | Render the `<details>` block with the raw Markdown |
+| `colorFreezeLevel` | — | Depth at which node colours are frozen |
+
+## Client rendering
+
+The client initializer is static and receives no plugin options. `height` and
+`colorFreezeLevel` are embedded into the figure's `data-markmap-*` attributes,
+and `initMarkmap` reads them from there.
+
+`markmap-lib` and `markmap-view` are fetched from jsDelivr with a computed
+import specifier, so they are never bundled into the host's client bundle.
+`markmap-view` pulls `d3` in as its own dependency. Because the libraries are
+loaded lazily, the page still renders (with the fallback `details`) when
+JavaScript is disabled.
+
+## The input-notation seam
+
+The code-block body is turned into a mindmap tree by a single, pure function in
+`src/parse.ts`:
+
+```ts
+parseMarkmapSource(source: string): MarkmapNode | null
+```
+
+`MarkmapNode` is the notation-neutral tree (`{ content, children, payload? }`).
+Only the standard Markdown-heading notation is implemented today. A future
+alternative notation (for example an "ExcaliMindMap"-style outline) is added by
+implementing another parser that produces the same `MarkmapNode` shape; the
+figure emission and the render path do not parse the notation themselves, so
+they stay unchanged. `parseMarkmapSource` is exported from the package entry
+point for that purpose.
+
+## Output hooks
+
+- `figure[data-markmap]`: state (`pending` / `rendered` / `error`)
+- `figure[data-markmap-source]`: the raw Markdown
+- `figure[data-markmap-height]`, `figure[data-markmap-color-freeze-level]`
+- `[data-markmap-canvas]`: the render target
+- `details.rb-markmap__fallback`: the raw Markdown
+
+## Main exports
+
+- `markmap(options?)`: create the plugin (`markmapPlugin` is an alias)
+- `initMarkmap`: initialize client-side rendering
+- `parseMarkmapSource`: parse the standard notation into a tree
+- `describeMarkmapTree`: derive an accessible label from a tree
+- Types: `MarkmapOptions`, `MarkmapNode`, `MarkmapClientOptions`
+
+## Limitations
+
+- Rendering is client-only. Nothing is rendered at build time, so mindmaps are
+  not visible without JavaScript (the source remains in the fallback `details`)
+- The client fetches `markmap-lib`, `markmap-view`, and their CDN sub-modules on
+  first use, so the first render waits on the network
+- Not every Markdown extension is supported by the standard notation; the
+  parser recognises ATX (`#`) headings and ignores fenced code blocks
+- `markmap-lib` and `markmap-view` are MIT licensed
+
+## See also
+
+- [Plugin system](../../../docs/en/plugin-system.md)

package/README_ja.md

@@ -0,0 +1,113 @@
+# @riebeckite/plugin-markmap
+
+` ```markmap ` コードブロックを、Markdown の見出しから組み立てるマインドマップとして表示するプラグインです。マインドマップはブラウザ側で `markmap-lib` と `markmap-view` により描画し、これらのライブラリは図があるときだけ CDN から読み込みます。
+
+[English](./README.md)
+
+## 設定する
+
+```ts
+import { defineConfig } from "@riebeckite/core";
+import { markmap } from "@riebeckite/plugin-markmap";
+
+export default defineConfig({
+  // ...
+  plugins: [
+    markmap({
+      caption: true,
+      height: 320,
+      fallback: true,
+    }),
+  ],
+});
+```
+
+このプラグインは `order: -10` で実行されます。
+
+## 記法
+
+コードブロックの本文は通常の Markdown です。見出しがノードになり、見出しの階層が木構造になります。見出し以外の内容は無視します。
+
+````markdown
+```markmap
+# プロジェクト
+
+## 設計
+
+### 記法
+### 描画
+
+## リリース
+```
+````
+
+キャプションにはコードブロックの `title` を使います。
+
+## どのように描画されるか
+
+` ```markmap ` のコードブロックは `figure.rb-markmap` に置き換わります。
+
+- `figure.rb-markmap`: `data-markmap="pending"`、`data-markmap-source`（元の Markdown）、`data-markmap-height` を持ちます
+- `div.rb-markmap__canvas`: SVG を描画する領域（`role="img"`）
+- `figcaption.rb-markmap__caption`: キャプション（既定で有効）
+- `details.rb-markmap__fallback`: 元の Markdown を折りたたんで表示
+
+`initMarkmap` は `[data-markmap="pending"]` を探し、ランタイムを読み込んでから `markmap-lib` の `Transformer` を `data-markmap-source` に適用し、得られた木を `markmap-view` の `Markmap.create` で描画します。描画に成功すると `data-markmap="rendered"` になります。
+
+ランタイムの読み込み、ソースの変換、描画のいずれかが失敗した場合は例外を投げず、その figure の `details` を開いて元の Markdown を見せます（`data-markmap="error"`）。
+
+Markdown の見出しを 1 つも含まないコードブロックは置き換えず、通常のコードブロックのまま残し、`source: "@riebeckite/plugin-markmap"` を持つ診断を出します。
+
+## オプション
+
+| 項目 | 既定値 | 説明 |
+| --- | --- | --- |
+| `caption` | `true` | コードブロックの `title` をキャプションとして表示する |
+| `height` | `320` | キャンバスの高さ（ピクセル） |
+| `className` | `"rb-markmap"` | figure に付ける基準クラス |
+| `language` | `"markmap"` | 対象にするコードブロックの言語 |
+| `fallback` | `true` | 元の Markdown を表示する `details` を描画する |
+| `colorFreezeLevel` | — | ノードの色を固定する深さ |
+
+## クライアント側の描画
+
+クライアントの初期化コードは静的なので、プラグインのオプションは受け取りません。`height` と `colorFreezeLevel` は figure の `data-markmap-*` 属性に埋め込まれ、`initMarkmap` がそこから読み取ります。
+
+`markmap-lib` と `markmap-view` は計算された import 指定子で jsDelivr から取得するため、ホストのクライアントバンドルには含まれません。`markmap-view` は依存として `d3` を読み込みます。ライブラリを遅延して読み込むので、JavaScript を無効にしていてもページは表示され、元の Markdown はフォールバックの `details` から読めます。
+
+## 入力記法の継ぎ目（notation seam）
+
+コードブロックの本文は、`src/parse.ts` にある単一の純粋関数でマインドマップの木に変換します。
+
+```ts
+parseMarkmapSource(source: string): MarkmapNode | null
+```
+
+`MarkmapNode` は記法に依存しない木（`{ content, children, payload? }`）です。現在は標準の Markdown 見出し記法だけを実装しています。将来別の入力記法（たとえば "ExcaliMindMap" 風のアウトライン）を追加するときは、同じ `MarkmapNode` を返すパーサーを実装するだけです。figure の生成と描画の経路は記法を解析しないため、変更する必要はありません。`parseMarkmapSource` はそのためにパッケージのエントリーポイントから公開しています。
+
+## 出力のフック
+
+- `figure[data-markmap]`: 状態（`pending` / `rendered` / `error`）
+- `figure[data-markmap-source]`: 元の Markdown
+- `figure[data-markmap-height]`、`figure[data-markmap-color-freeze-level]`
+- `[data-markmap-canvas]`: 描画先の要素
+- `details.rb-markmap__fallback`: 元の Markdown
+
+## 主なエクスポート
+
+- `markmap(options?)`: プラグインを作成する（`markmapPlugin` は別名）
+- `initMarkmap`: クライアント側の描画を初期化する
+- `parseMarkmapSource`: 標準記法を木に変換する
+- `describeMarkmapTree`: 木からアクセシブルなラベルを作る
+- 型: `MarkmapOptions`、`MarkmapNode`、`MarkmapClientOptions`
+
+## 制限
+
+- 描画はクライアント側のみです。ビルド時に何も生成しないため、JavaScript が無効な環境ではマインドマップは表示されません（元の Markdown はフォールバックの `details` に残ります）
+- クライアントは初回描画時に `markmap-lib`、`markmap-view` とその CDN サブモジュールを取得するため、最初の描画はネットワーク待ちになります
+- 標準記法が対応する Markdown 拡張は限られます。パーサーは ATX（`#`）見出しを認識し、コードフェンス内は無視します
+- `markmap-lib` と `markmap-view` は MIT ライセンスです
+
+## 関連資料
+
+- [プラグインシステム](../../../docs/ja/plugin-system.md)

package/dist/client.d.ts

@@ -0,0 +1,2 @@
+export { initMarkmap } from "./src/init.js";
+export type { MarkmapAssets, MarkmapClientOptions, MarkmapNode, MarkmapPureNode, MarkmapRuntime, MarkmapTransformer, MarkmapTransformResult, } from "./src/types.js";

package/dist/client.js

@@ -0,0 +1,118 @@
+// src/init.ts
+var DEFAULT_CLASS_NAME = "rb-markmap";
+var SVG_NAMESPACE = "http://www.w3.org/2000/svg";
+var DEFAULT_LIB_URL = "https://cdn.jsdelivr.net/npm/markmap-lib@0.18.12/+esm";
+var DEFAULT_VIEW_URL = "https://cdn.jsdelivr.net/npm/markmap-view@0.18.12/+esm";
+async function initMarkmap(options = {}) {
+  const baseClass = options.className?.trim() || DEFAULT_CLASS_NAME;
+  const figures = Array.from(
+    document.querySelectorAll('[data-markmap="pending"]')
+  );
+  if (figures.length === 0) return;
+  const runtime = await loadRuntime(options);
+  if (!runtime) {
+    for (const figure of figures) setError(figure);
+    return;
+  }
+  for (const figure of figures) {
+    await renderFigure(runtime, figure, baseClass);
+  }
+}
+async function renderFigure(runtime, figure, baseClass) {
+  const canvas = figure.querySelector(
+    `[data-markmap-canvas], .${baseClass}__canvas`
+  );
+  const source = figure.dataset.markmapSource;
+  if (!canvas || !source) {
+    setError(figure);
+    return;
+  }
+  try {
+    const transformer = new runtime.Transformer();
+    const result = transformer.transform(source);
+    await loadAssets(runtime, transformer.getUsedAssets(result.features));
+    const svg = ensureSvg(canvas, baseClass, figure.dataset.markmapHeight);
+    const markmapOptions = buildOptions(
+      runtime,
+      figure.dataset.markmapColorFreezeLevel,
+      result.frontmatter?.markmap
+    );
+    runtime.Markmap.create(svg, markmapOptions, result.root);
+    figure.dataset.markmap = "rendered";
+  } catch {
+    setError(figure);
+  }
+}
+function ensureSvg(canvas, baseClass, height) {
+  const existing = canvas.querySelector("svg");
+  if (existing) return existing;
+  const svg = document.createElementNS(SVG_NAMESPACE, "svg");
+  svg.setAttribute("class", `${baseClass}__svg`);
+  svg.setAttribute("width", "100%");
+  svg.setAttribute("height", height && Number(height) > 0 ? height : "320");
+  svg.setAttribute("role", "presentation");
+  canvas.append(svg);
+  return svg;
+}
+function buildOptions(runtime, colorFreezeLevel, frontmatterOptions) {
+  const json = { ...frontmatterOptions ?? {} };
+  const freeze = readNumber(colorFreezeLevel);
+  if (freeze !== void 0) json.colorFreezeLevel = freeze;
+  return runtime.deriveOptions ? runtime.deriveOptions(json) : json;
+}
+async function loadAssets(runtime, assets) {
+  const tasks = [];
+  if (runtime.loadJS && assets.scripts?.length) {
+    tasks.push(runtime.loadJS(assets.scripts));
+  }
+  if (runtime.loadCSS && assets.styles?.length) {
+    tasks.push(runtime.loadCSS(assets.styles));
+  }
+  await Promise.all(tasks).catch(() => void 0);
+}
+async function loadRuntime(options) {
+  if (options.runtime) return options.runtime;
+  try {
+    const [lib, view] = await Promise.all([
+      importModule(options.libUrl ?? DEFAULT_LIB_URL),
+      importModule(options.viewUrl ?? DEFAULT_VIEW_URL)
+    ]);
+    const Transformer = readExport(lib, "Transformer");
+    const Markmap = readExport(view, "Markmap");
+    if (typeof Transformer !== "function" || !Markmap) return null;
+    return {
+      Transformer,
+      Markmap,
+      deriveOptions: readExport(view, "deriveOptions"),
+      loadJS: readExport(view, "loadJS"),
+      loadCSS: readExport(view, "loadCSS")
+    };
+  } catch {
+    return null;
+  }
+}
+function importModule(url) {
+  const importer = new Function(
+    "url",
+    "return import(url)"
+  );
+  return importer(url);
+}
+function readExport(module, name) {
+  if (name in module) return module[name];
+  const fallback = module.default;
+  return fallback?.[name];
+}
+function readNumber(value) {
+  if (value === void 0) return void 0;
+  const parsed = Number(value);
+  return Number.isFinite(parsed) ? parsed : void 0;
+}
+function setError(figure) {
+  figure.dataset.markmap = "error";
+  const fallback = figure.querySelector("details");
+  if (fallback) fallback.open = true;
+}
+export {
+  initMarkmap
+};

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+import type { MarkmapOptions } from "./src/types.js";
+export { resolveMarkmapOptions } from "./src/options.js";
+export { describeMarkmapTree, parseMarkmapSource } from "./src/parse.js";
+export type { MarkmapClientOptions, MarkmapNode, MarkmapOptions, MarkmapResolvedOptions, } from "./src/types.js";
+/**
+ * Renders fenced `markmap` code blocks as Markdown-heading mindmaps. The mindmap
+ * is drawn in the browser by `initMarkmap`, which imports `markmap-lib` and
+ * `markmap-view` from the CDN only when a figure is present.
+ */
+export declare function markmap(options?: MarkmapOptions): import("@riebeckite/core").RiebeckitePlugin<MarkmapOptions>;
+/** Alias kept for symmetry with the other plugin factories. */
+export declare const markmapPlugin: typeof markmap;

package/dist/index.js

@@ -0,0 +1,264 @@
+// index.ts
+import {
+  createClientEntry,
+  createStyleAsset,
+  definePlugin
+} from "@riebeckite/core";
+
+// src/options.ts
+var DEFAULT_MARKMAP_CLASS_NAME = "rb-markmap";
+var DEFAULT_MARKMAP_HEIGHT = 320;
+var DEFAULT_MARKMAP_LANGUAGE = "markmap";
+function resolveMarkmapOptions(options = {}) {
+  return {
+    caption: options.caption !== false,
+    height: normalizeHeight(options.height),
+    className: options.className?.trim() || DEFAULT_MARKMAP_CLASS_NAME,
+    language: options.language?.trim() || DEFAULT_MARKMAP_LANGUAGE,
+    fallback: options.fallback !== false,
+    colorFreezeLevel: normalizeColorFreezeLevel(options.colorFreezeLevel)
+  };
+}
+function normalizeHeight(height) {
+  return typeof height === "number" && Number.isFinite(height) && height > 0 ? height : DEFAULT_MARKMAP_HEIGHT;
+}
+function normalizeColorFreezeLevel(level) {
+  return typeof level === "number" && Number.isInteger(level) && level >= 0 ? level : null;
+}
+
+// src/parse.ts
+var ATX_HEADING = /^ {0,3}(#{1,6})(?:[ \t]+(.*?))?[ \t]*#*[ \t]*$/;
+var CODE_FENCE = /^ {0,3}(`{3,}|~{3,})/;
+function parseMarkmapSource(source) {
+  const roots = [];
+  const stack = [];
+  let fence = null;
+  for (const line of source.split(/\r?\n/)) {
+    const fenceMatch = CODE_FENCE.exec(line);
+    if (fenceMatch) {
+      const marker = fenceMatch[1][0];
+      if (fence === null) fence = marker;
+      else if (fence === marker) fence = null;
+      continue;
+    }
+    if (fence !== null) continue;
+    const heading = ATX_HEADING.exec(line);
+    if (!heading) continue;
+    const level = heading[1].length;
+    const node = {
+      content: (heading[2] ?? "").trim(),
+      children: []
+    };
+    while (stack.length > 0 && stack[stack.length - 1].level >= level) {
+      stack.pop();
+    }
+    const parent = stack[stack.length - 1];
+    if (parent) parent.node.children.push(node);
+    else roots.push(node);
+    stack.push({ level, node });
+  }
+  if (roots.length === 0) return null;
+  if (roots.length === 1) return roots[0];
+  return { content: "", children: roots };
+}
+function describeMarkmapTree(tree) {
+  if (!tree) return "";
+  if (tree.content.trim() !== "") return tree.content.trim();
+  for (const child of tree.children) {
+    const label = describeMarkmapTree(child);
+    if (label !== "") return label;
+  }
+  return "";
+}
+
+// src/rehype.ts
+var DIAGNOSTIC_SOURCE = "@riebeckite/plugin-markmap";
+function rehypeMarkmap(options = {}) {
+  const resolved = resolveMarkmapOptions(options);
+  return (tree, file) => {
+    visitElements(tree, (node, parent, index) => {
+      if (!parent || index === void 0) return;
+      if (!isMarkmapCodeBlock(node, resolved.language)) return;
+      replaceMarkmapBlock(parent, index, node, file, resolved);
+    });
+  };
+}
+function replaceMarkmapBlock(parent, index, pre, file, options) {
+  const code = findDirectChild(pre, "code");
+  const source = code ? getTextContent(code).trim() : getTextContent(pre).trim();
+  const tree = parseMarkmapSource(source);
+  if (tree === null) {
+    reportDiagnostic(file, "Expected at least one Markdown heading.");
+    return;
+  }
+  const caption = options.caption ? extractCaption(pre, code) : null;
+  const label = caption ?? describeMarkmapTree(tree);
+  parent.children = parent.children ?? [];
+  parent.children[index] = buildFigure({
+    className: options.className,
+    source,
+    caption,
+    label: label || "Mind map",
+    height: options.height,
+    fallback: options.fallback,
+    colorFreezeLevel: options.colorFreezeLevel
+  });
+}
+function buildFigure(input) {
+  const base = input.className;
+  const labelId = `${base}-caption`;
+  const children = [
+    element(
+      "div",
+      {
+        className: `${base}__canvas`,
+        dataMarkmapCanvas: "true",
+        role: "img",
+        ariaLabelledby: input.caption ? labelId : void 0,
+        ariaLabel: input.caption ? void 0 : input.label
+      },
+      []
+    )
+  ];
+  if (input.caption) {
+    children.push(
+      element("figcaption", { id: labelId, className: `${base}__caption` }, [
+        text(input.caption)
+      ])
+    );
+  }
+  if (input.fallback) {
+    children.push(
+      element("details", { className: `${base}__fallback` }, [
+        element("summary", {}, [text("Markdown source")]),
+        element("pre", {}, [element("code", {}, [text(input.source)])])
+      ])
+    );
+  }
+  return element(
+    "figure",
+    {
+      className: base,
+      dataMarkmap: "pending",
+      dataMarkmapSource: input.source,
+      dataMarkmapHeight: String(input.height),
+      dataMarkmapColorFreezeLevel: input.colorFreezeLevel === null ? void 0 : String(input.colorFreezeLevel)
+    },
+    children
+  );
+}
+function extractCaption(pre, code) {
+  const title = getStringProperty(pre, "title") ?? (code ? getStringProperty(code, "title") : null);
+  return title?.trim() || null;
+}
+function isMarkmapCodeBlock(node, language) {
+  if (node.tagName !== "pre") return false;
+  const code = findDirectChild(node, "code");
+  return Boolean(code && hasClass(code, `language-${language}`));
+}
+function findDirectChild(node, tagName) {
+  return node.children?.find(
+    (child) => child.type === "element" && child.tagName === tagName
+  ) ?? null;
+}
+function reportDiagnostic(file, message) {
+  const reporter = file?.message;
+  if (typeof reporter !== "function") return;
+  const diagnostic = reporter.call(
+    file,
+    `Invalid Markmap source: ${message}`
+  );
+  if (diagnostic && typeof diagnostic === "object") {
+    Object.assign(diagnostic, {
+      source: DIAGNOSTIC_SOURCE,
+      ruleId: "invalid-source"
+    });
+  }
+}
+function visitElements(node, visitor, parent, index) {
+  if (isElementNode(node)) visitor(node, parent, index);
+  for (const [childIndex, child] of [...getChildren(node)].entries()) {
+    visitElements(child, visitor, hasChildren(node) ? node : parent, childIndex);
+  }
+}
+function element(tagName, properties = {}, children = []) {
+  return { type: "element", tagName, properties, children };
+}
+function text(value) {
+  return { type: "text", value };
+}
+function getTextContent(node) {
+  if (node.type === "text" && "value" in node && typeof node.value === "string") {
+    return node.value;
+  }
+  return getChildren(node).map(getTextContent).join("");
+}
+function getStringProperty(node, key) {
+  const value = node.properties?.[key];
+  if (typeof value === "string") return value;
+  if (Array.isArray(value)) return value.join(" ");
+  return null;
+}
+function hasClass(node, className) {
+  const value = node.properties?.className;
+  const classes = Array.isArray(value) ? value.map(String) : typeof value === "string" ? value.split(/\s+/) : [];
+  return classes.includes(className);
+}
+function isElementNode(node) {
+  return node.type === "element";
+}
+function hasChildren(node) {
+  return Array.isArray(node.children);
+}
+function getChildren(node) {
+  const children = node.children;
+  return Array.isArray(children) ? children : [];
+}
+
+// index.ts
+function markmap(options = {}) {
+  return definePlugin({
+    name: "markmap",
+    order: -10,
+    options,
+    validateOptions: validateMarkmapOptions,
+    extendHtmlPipeline: (pipeline) => {
+      pipeline.use(rehypeMarkmap, options);
+    },
+    assets: [createStyleAsset("markmap")],
+    clientEntries: [createClientEntry("markmap", "initMarkmap")]
+  });
+}
+var markmapPlugin = markmap;
+function validateMarkmapOptions(options) {
+  if (!options) return [];
+  const issues = [];
+  for (const key of ["caption", "fallback"]) {
+    if (options[key] !== void 0 && typeof options[key] !== "boolean") {
+      issues.push({ path: key, message: "Expected a boolean." });
+    }
+  }
+  for (const key of ["className", "language"]) {
+    const value = options[key];
+    if (value !== void 0 && (typeof value !== "string" || value.trim() === "")) {
+      issues.push({ path: key, message: "Expected a non-empty string." });
+    }
+  }
+  if (options.height !== void 0 && (typeof options.height !== "number" || !Number.isFinite(options.height) || options.height <= 0)) {
+    issues.push({ path: "height", message: "Expected a positive number." });
+  }
+  if (options.colorFreezeLevel !== void 0 && (!Number.isInteger(options.colorFreezeLevel) || options.colorFreezeLevel < 0)) {
+    issues.push({
+      path: "colorFreezeLevel",
+      message: "Expected a non-negative integer."
+    });
+  }
+  return issues;
+}
+export {
+  describeMarkmapTree,
+  markmap,
+  markmapPlugin,
+  parseMarkmapSource,
+  resolveMarkmapOptions
+};

package/dist/src/init.d.ts

@@ -0,0 +1,9 @@
+import type { MarkmapClientOptions } from "./types.js";
+/**
+ * Renders every server-emitted `[data-markmap="pending"]` figure in the
+ * browser.
+ *
+ * The Markdown source travels in `data-markmap-source`, so the page still
+ * renders (with the fallback `<details>`) when JavaScript is disabled.
+ */
+export declare function initMarkmap(options?: MarkmapClientOptions): Promise<void>;

package/dist/src/options.d.ts

@@ -0,0 +1,14 @@
+import type { MarkmapOptions, MarkmapResolvedOptions } from "./types.js";
+/** Default base class for the generated figure. */
+export declare const DEFAULT_MARKMAP_CLASS_NAME = "rb-markmap";
+/** Default canvas height in pixels. */
+export declare const DEFAULT_MARKMAP_HEIGHT = 320;
+/** Default fenced-code language. */
+export declare const DEFAULT_MARKMAP_LANGUAGE = "markmap";
+/**
+ * Applies defaults to the user-provided options.
+ *
+ * Shared by the plugin factory (for metadata/validation) and the rehype
+ * transformer (for figure emission), so both agree on a single resolution.
+ */
+export declare function resolveMarkmapOptions(options?: MarkmapOptions): MarkmapResolvedOptions;

package/dist/src/parse.d.ts

@@ -0,0 +1,21 @@
+import type { MarkmapNode } from "./types.js";
+/**
+ * Parses a fenced code block body written in the standard Markmap
+ * Markdown-heading notation into a mindmap tree.
+ *
+ * This is the **input-notation seam** of the plugin: every supported notation
+ * produces the same `MarkmapNode` shape, so a future alternative notation (for
+ * example an "ExcaliMindMap"-style outline) only has to add another parser
+ * here instead of touching the figure/render path. See the READMEs for the
+ * documented contract.
+ *
+ * Returns `null` when the source contains no heading at all, which the rehype
+ * transformer reports as an invalid block. Content inside fenced code blocks is
+ * ignored, mirroring Markdown parsing.
+ */
+export declare function parseMarkmapSource(source: string): MarkmapNode | null;
+/**
+ * Returns a human-readable label for a parsed tree, used as a fallback
+ * accessible name for the rendered canvas.
+ */
+export declare function describeMarkmapTree(tree: MarkmapNode | null): string;

package/dist/src/rehype.d.ts

@@ -0,0 +1,7 @@
+import type { HastNode, MarkmapOptions } from "./types.js";
+/**
+ * Replaces every fenced `markmap` code block with a figure that carries the
+ * raw Markdown in `data-markmap-source`. The mindmap itself is drawn in the
+ * browser by `initMarkmap`.
+ */
+export declare function rehypeMarkmap(options?: MarkmapOptions): (tree: HastNode, file: unknown) => void;

package/dist/src/types.d.ts

@@ -0,0 +1,114 @@
+/**
+ * Public types for the Markmap plugin.
+ *
+ * This module is imported by the build-time transformer, the browser
+ * initializer, and the package entry point, so it must stay free of Node-only
+ * imports.
+ */
+/** A node in the notation-neutral mindmap tree. */
+export type MarkmapNode = {
+    /** Raw (Markdown) content of the node. */
+    content: string;
+    /** Child nodes, in document order. */
+    children: MarkmapNode[];
+    /** Extra data reserved for alternative input notations. */
+    payload?: Record<string, unknown>;
+};
+/**
+ * Options accepted by the `markmap` plugin factory.
+ *
+ * Note that client initializers are static, so the resolved values are
+ * forwarded to the browser through `data-markmap-*` attributes.
+ */
+export type MarkmapOptions = {
+    /** Render the code-block title as a `<figcaption>`. Defaults to `true`. */
+    caption?: boolean;
+    /** Canvas height in pixels. Defaults to `320`. */
+    height?: number;
+    /** Base CSS class applied to the figure. Defaults to `"rb-markmap"`. */
+    className?: string;
+    /** Fenced-code language to recognize. Defaults to `"markmap"`. */
+    language?: string;
+    /** Render a `<details>` block holding the raw Markdown. Defaults to `true`. */
+    fallback?: boolean;
+    /**
+     * Depth at which node colours are frozen, forwarded to `markmap-view`.
+     * Omission keeps the `markmap-view` default.
+     */
+    colorFreezeLevel?: number;
+};
+/** Options after defaults have been applied. */
+export type MarkmapResolvedOptions = {
+    caption: boolean;
+    height: number;
+    className: string;
+    language: string;
+    fallback: boolean;
+    colorFreezeLevel: number | null;
+};
+/** Options accepted by `initMarkmap` when called programmatically. */
+export type MarkmapClientOptions = {
+    /** Base class used to find figures. Defaults to `"rb-markmap"`. */
+    className?: string;
+    /** ESM URL of `markmap-lib`. Defaults to the pinned jsDelivr build. */
+    libUrl?: string;
+    /** ESM URL of `markmap-view`. Defaults to the pinned jsDelivr build. */
+    viewUrl?: string;
+    /** Preloaded runtime, used to skip the CDN import. */
+    runtime?: MarkmapRuntime;
+};
+/** The subset of `markmap-common`'s `IPureNode` the renderer relies on. */
+export type MarkmapPureNode = {
+    content: string;
+    children: MarkmapPureNode[];
+    payload?: Record<string, unknown>;
+};
+/** Result of `markmap-lib`'s `Transformer#transform`. */
+export type MarkmapTransformResult = {
+    root: MarkmapPureNode;
+    features: Record<string, boolean>;
+    frontmatter?: {
+        markmap?: Record<string, unknown>;
+    };
+};
+/** Assets reported by `markmap-lib` for a set of used features. */
+export type MarkmapAssets = {
+    styles?: unknown[];
+    scripts?: unknown[];
+};
+/** The `markmap-lib` surface the initializer uses. */
+export type MarkmapTransformer = {
+    transform(source: string): MarkmapTransformResult;
+    getUsedAssets(features: Record<string, boolean>): MarkmapAssets;
+};
+/** The `markmap-view` surface the initializer uses. */
+export type MarkmapRuntime = {
+    Transformer: new () => MarkmapTransformer;
+    Markmap: {
+        create(svg: SVGElement, options: Record<string, unknown>, root: MarkmapPureNode): unknown;
+    };
+    deriveOptions?: (options: Record<string, unknown>) => Record<string, unknown>;
+    loadJS?: (items: unknown[]) => Promise<void>;
+    loadCSS?: (items: unknown[]) => Promise<void>;
+};
+export type ElementNode = {
+    type: string;
+    tagName?: string;
+    properties?: Record<string, unknown>;
+    children?: HastNode[];
+};
+export type ParentNode = HastNode & {
+    children?: HastNode[];
+};
+export type TextNode = {
+    type: "text";
+    value: string;
+};
+export type RawNode = {
+    type: "raw";
+    value: string;
+};
+export type HastNode = ElementNode | TextNode | RawNode | {
+    type: string;
+    [key: string]: unknown;
+};

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@riebeckite/plugin-markmap",
+  "version": "0.0.1",
+  "license": "Apache-2.0",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "source": "./index.ts",
+      "default": "./dist/index.js"
+    },
+    "./client": {
+      "types": "./dist/client.d.ts",
+      "import": "./dist/client.js",
+      "source": "./client.ts",
+      "default": "./dist/client.js"
+    },
+    "./style.css": "./style.css"
+  },
+  "dependencies": {
+    "markmap-lib": "^0.18.12",
+    "markmap-view": "^0.18.12",
+    "@riebeckite/core": "0.0.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "LICENSE",
+    "README.md",
+    "README_ja.md",
+    "dist",
+    "style.css"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Rerurate514/riebeckite.git",
+    "directory": "packages/plugins/markmap"
+  },
+  "homepage": "https://github.com/Rerurate514/riebeckite#readme",
+  "bugs": {
+    "url": "https://github.com/Rerurate514/riebeckite/issues"
+  },
+  "description": "Markdown mindmap rendering with Markmap for Riebeckite.",
+  "keywords": [
+    "riebeckite",
+    "plugin",
+    "markmap",
+    "mindmap"
+  ],
+  "engines": {
+    "node": "^20.19.0 || >=22.12.0"
+  },
+  "sideEffects": [
+    "./style.css"
+  ],
+  "scripts": {
+    "build": "node ../../../scripts/build_package.mjs"
+  }
+}

package/style.css

@@ -0,0 +1,67 @@
+.rb-markmap {
+  --rb-markmap-paper: var(--rb-color-paper, #ffffff);
+  --rb-markmap-ink: var(--rb-color-ink, #000000);
+  --rb-markmap-muted: var(--rb-color-muted, #69645c);
+  --rb-markmap-rule: var(
+    --rb-color-border,
+    color-mix(in srgb, var(--rb-markmap-ink) 18%, transparent)
+  );
+  margin: 2rem 0;
+  border: 1px solid var(--rb-markmap-rule);
+  background: color-mix(
+    in srgb,
+    var(--rb-markmap-paper) 96%,
+    var(--rb-markmap-ink)
+  );
+  color: var(--rb-markmap-ink);
+}
+
+.rb-markmap__caption {
+  padding: 0.625rem 0.75rem;
+  border-bottom: 1px solid var(--rb-markmap-rule);
+  color: var(--rb-markmap-muted);
+  font-size: 0.875rem;
+}
+
+.rb-markmap__canvas {
+  overflow: auto;
+  padding: 1rem;
+}
+
+.rb-markmap__canvas > .rb-markmap__svg,
+.rb-markmap__canvas > svg {
+  display: block;
+  max-width: 100%;
+}
+
+.rb-markmap__fallback {
+  border-top: 1px solid var(--rb-markmap-rule);
+  color: var(--rb-markmap-muted);
+  font-size: 0.8125rem;
+}
+
+.rb-markmap__fallback summary {
+  cursor: pointer;
+  padding: 0.5rem 0.75rem;
+}
+
+.rb-markmap__fallback pre {
+  overflow: auto;
+  margin: 0 1rem;
+  padding: 0.75rem;
+  border-top: 1px solid var(--rb-markmap-rule);
+  color: var(--rb-markmap-ink);
+  background: color-mix(in srgb, var(--rb-markmap-ink) 6%, transparent);
+}
+
+.rb-markmap[data-markmap="error"] .rb-markmap__canvas:empty::before,
+.rb-markmap[data-markmap="pending"] .rb-markmap__canvas:empty::before {
+  content: "Mind map could not be rendered.";
+  color: var(--rb-markmap-muted);
+}
+
+html[data-theme="dark"] .rb-markmap,
+html.dark .rb-markmap {
+  --rb-markmap-paper: var(--rb-color-ink, #000000);
+  --rb-markmap-ink: var(--rb-color-paper, #ffffff);
+}