@riebeckite/plugin-marp 0.0.18 → 0.0.20

package/README.md

@@ -1,6 +1,6 @@
 # @riebeckite/plugin-marp
 
-Render `marp` code blocks as Marp slide decks at build time.
+Render Marp slide decks at build time. A note whose YAML frontmatter contains `marp: true` is rendered as a whole-document deck, and `marp` fenced code blocks render as inline decks.
 
 [日本語](./README_ja.md)
 
@@ -23,6 +23,30 @@ export default defineConfig({
 });
 ```
 
+## Obsidian vault compatibility
+
+The Obsidian plugins [Marp](https://github.com/jichoup/obsidian-marp-plugin) and [Marp Slides](https://github.com/samuele-cozzi/obsidian-marp-slides) treat the entire note as a Marp deck and never store `marp` code fences. In Obsidian, activation is plugin-level: opening the slide preview or exporting renders the whole file of the active note, and neither plugin reads a per-note marker. Riebeckite instead activates per document using the canonical `marp: true` frontmatter flag — the same signal Marp CLI and the VS Code extension use — so notes written for those plugins are detected as:
+
+````markdown
+---
+marp: true
+theme: gaia
+paginate: true
+---
+
+# First slide
+
+---
+
+# Second slide
+````
+
+The whole document (frontmatter included, so directives such as `theme` and `paginate` apply) is rendered as one `<figure class="rb-marp">` deck that replaces the page body. Slide separators are `---` / `===`, exactly like Marp. Notes without the flag or any `marp` code block are left untouched.
+
+> **Activation contract.** Riebeckite is not activated the way the Obsidian plugins are. A note that showed as slides in Obsidian (because you opened the slide preview for it) will **not** render as a deck here unless `marp: true` is present in its frontmatter. Adding that one line is the only change such a vault needs — the deck body (separators, `theme` / `paginate` and other directives, standard Marp syntax) is used exactly as stored. In other words, the output follows Marp semantics, while the plugins' zero-config, plugin-level activation is not reproduced. Treat this as content-compatible, not fully drop-in.
+
+## Inline decks
+
 In a note, write a fenced code block whose info string is `marp`. Slides are separated by `---`, exactly like Marp. Setting the code block `title` renders a caption.
 
 ````markdown
@@ -90,13 +114,15 @@ An unknown theme falls back to the default theme and emits a diagnostic with `so
 - No client-side slide editing or paging UI; this only produces static HTML/CSS at build time.
 - Only themes registered in Marp Core are available; loading arbitrary theme CSS is not supported.
 - `inlineSVG: false` emits bare `<section>` elements without the SVG wrapper, and the generated CSS changes to match that structure.
+- Whole-document decks bypass the normal Markdown pipeline, so Obsidian `![[image]]` image embeds are not resolved inside slides. Use regular Markdown image syntax with paths that exist on the published site, mirroring how Marp Slides itself does not support wiki links.
 
 ## Exports
 
 - `marp(options?)` / `marpPlugin(options?)` — plugin factory
+- `isMarpDocument(matter?)` — frontmatter `marp: true` detection helper
 - Types: `MarpOptions`, `MarpDeck`, `MarpBuildRenderResult`
 
 ## See also
 
-- [Plugin guide](../../../docs/docs/reference/plugin-api.en.md)
+- [Plugin guide](../../../docs/docs/reference/plugin-api.md)
 

package/README_ja.md

@@ -1,6 +1,6 @@
 # @riebeckite/plugin-marp
 
-`marp` コードブロックを Marp のスライドデッキとしてビルド時に描画するプラグインです。
+Marp のスライドデッキをビルド時に描画するプラグインです。YAML frontmatter に `marp: true` を含むノートは文書全体をデッキとして描画し、`marp` コードブロックはインラインデッキとして描画します。
 
 [English](./README.md)
 
@@ -23,6 +23,30 @@ export default defineConfig({
 });
 ```
 
+## Obsidian Vault との互換性
+
+Obsidian プラグインの [Marp](https://github.com/jichoup/obsidian-marp-plugin) と [Marp Slides](https://github.com/samuele-cozzi/obsidian-marp-slides) はノート全体を Marp デッキとして扱い、`marp` コードフェンスを保存しません。Obsidian 側のアクティベーションはプラグイン単位です。スライドプレビューを開いたり、エクスポートしたりすると、アクティブなノートのファイル全体をデッキとして描画し、ノート単位のマーカーは読みません。Riebeckite では代わりに、文書単位で Marp CLI や VS Code 拡張と同じ canonical なフラグ（frontmatter の `marp: true`）によってデッキ化します。これらのプラグインで書いたノートは次のように検出されます。
+
+````markdown
+---
+marp: true
+theme: gaia
+paginate: true
+---
+
+# 1 枚目のスライド
+
+---
+
+# 2 枚目のスライド
+````
+
+文書全体（directive として `theme` や `paginate` を効かせるため frontmatter を含む）を、ページ本文を置き換える 1 つの `<figure class="rb-marp">` デッキとして描画します。スライドの区切りは Marp と同じく `---` / `===` です。フラグも `marp` コードブロックもないノートは変更しません。
+
+> **アクティベーションの契約.** Riebeckite は Obsidian プラグインと同じ方法ではアクティベートされません。Obsidian でスライドとして表示されていたノート（プレビューを開いたノート）も、frontmatter に `marp: true` がなければここではデッキとして描画されません。そのような Vault に必要な変更はこの 1 行の追加だけです。デッキの本体（セパレータ、`theme` / `paginate` などの directive、標準 Marp 構文）は保存された内容をそのまま使います。つまり、出力は Marp の意味論に従いますが、プラグインの設定不要なプラグインレベルでのアクティベーションは再現しません。完全なドロップイン互換ではなく「コンテンツ互換」として扱ってください。
+
+## インラインデッキ
+
 ノートでは、情報文字列に `marp` を付けたコードブロックを書きます。スライドの区切りは Marp と同じく `---` です。コードブロックの `title` を付けるとキャプションになります。
 
 ````markdown
@@ -94,9 +118,10 @@ export default defineConfig({
 ## 主なエクスポート
 
 - `marp(options?)` / `marpPlugin(options?)`: プラグインを作成する
+- `isMarpDocument(matter?)`: frontmatter の `marp: true` を判定するヘルパー
 - 型: `MarpOptions`、`MarpDeck`、`MarpBuildRenderResult`
 
 ## 関連資料
 
-- [プラグインシステム](../../../docs/docs/reference/plugin-api.md)
+- [プラグインシステム](../../../docs/docs/reference/plugin-api.ja.md)
 

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import type { MarpOptions } from "./src/types.js";
+export { isMarpDocument } from "./src/rehype.js";
 export type { MarpBuildRenderResult, MarpDeck, MarpOptions, } from "./src/types.js";
 /**
  * Renders ` ```marp ` code blocks as static Marp slide decks at build time.

package/dist/index.js

@@ -168,12 +168,23 @@ var init_render = __esm({
 // src/rehype.ts
 var rehype_exports = {};
 __export(rehype_exports, {
+  isMarpDocument: () => isMarpDocument,
   rehypeMarp: () => rehypeMarp
 });
+function isMarpDocument(matter) {
+  if (!matter || typeof matter !== "object") return false;
+  const flag = matter.marp;
+  return flag === true || flag === "true";
+}
 function rehypeMarp(options = {}) {
   const className = normalizeClassName(options.className);
   const deckClassName = `${className}__deck`;
   return async (tree, file) => {
+    const fileContext = file;
+    if (isMarpDocument(fileContext.data?.matter)) {
+      await renderWholeDocument(tree, file, fileContext.value ?? "", options);
+      return;
+    }
     const blocks = [];
     visitElements(tree, (node, parent, index) => {
       if (!parent || index === void 0 || !isMarpCodeBlock(node)) return;
@@ -222,6 +233,45 @@ function rehypeMarp(options = {}) {
     }
   };
 }
+async function renderWholeDocument(tree, file, source, options) {
+  const className = normalizeClassName(options.className);
+  const deckClassName = `${className}__deck`;
+  const trimmed = source.trim();
+  if (!trimmed) return;
+  const result = await renderMarpDeck(trimmed, {
+    theme: options.theme?.trim() || "default",
+    allowHtml: options.allowHtml !== false,
+    math: options.math !== false,
+    inlineSVG: options.inlineSVG,
+    deckClassName
+  });
+  if (result.ok === false) {
+    reportDiagnostic(
+      file,
+      `Marp rendering failed: ${result.message}`,
+      "render-error"
+    );
+    console.warn(`[marp] rendering failed: ${result.message}`);
+    return;
+  }
+  if (result.warning) {
+    reportDiagnostic(file, result.warning, "theme-fallback");
+    console.warn(`[marp] ${result.warning}`);
+  }
+  const scopedCss = scopeMarpCss(result.deck.css, className, deckClassName);
+  const root = tree;
+  root.children = [
+    buildFigure({
+      className,
+      deckClassName,
+      caption: null,
+      source: trimmed,
+      slides: result.deck.slides,
+      deckHtml: result.deck.html,
+      scopedCss
+    })
+  ];
+}
 function buildFigure(input) {
   const children = [];
   if (input.scopedCss) {
@@ -293,6 +343,7 @@ var init_rehype = __esm({
 });
 
 // index.ts
+init_rehype();
 import {
   createStyleAsset,
   definePlugin
@@ -349,6 +400,7 @@ function rehypeMarpLazy(options = {}) {
   };
 }
 export {
+  isMarpDocument,
   marp,
   marpPlugin
 };

package/dist/src/rehype.d.ts

@@ -1,2 +1,10 @@
 import type { HastNode, MarpOptions } from "./types.js";
+/**
+ * `marp: true` in YAML frontmatter is the detection signal used by the Marp
+ * ecosystem (Marp CLI and the VS Code extension) to treat a whole document as
+ * a Marp deck. The Obsidian Marp plugins (Marp by jichoup, Marp Slides by
+ * samuele-cozzi) render the entire note, so this flag and the code block below
+ * are the two supported entry points.
+ */
+export declare function isMarpDocument(matter: Record<string, unknown> | undefined): boolean;
 export declare function rehypeMarp(options?: MarpOptions): (tree: HastNode, file: unknown) => Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-marp",
-  "version": "0.0.18",
+  "version": "0.0.20",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -16,7 +16,10 @@
   },
   "dependencies": {
     "@marp-team/marp-core": "^4.4.0",
-    "@riebeckite/core": "0.0.18"
+    "@riebeckite/core": "0.0.20"
+  },
+  "devDependencies": {
+    "tsx": "^4.22.4"
   },
   "publishConfig": {
     "access": "public"
@@ -51,6 +54,7 @@
     "./style.css"
   ],
   "scripts": {
-    "build": "node ../../../scripts/build_package.mjs"
+    "build": "node ../../../scripts/build_package.mjs",
+    "test": "node --import tsx --test \"test/*.test.ts\""
   }
 }

package/style.css

@@ -58,8 +58,14 @@
   background: color-mix(in srgb, var(--rr-marp-ink) 6%, transparent);
 }
 
-html[data-theme="dark"] .rb-marp,
-html.dark .rb-marp {
+:is(:root, .rb-theme-root)[data-theme="dark"] .rb-marp {
   --rr-marp-paper: var(--rb-color-ink, #000000);
   --rr-marp-ink: var(--rb-color-paper, #ffffff);
 }
+
+@media (prefers-color-scheme: dark) {
+  :is(:root, .rb-theme-root):not([data-theme]) .rb-marp {
+    --rr-marp-paper: var(--rb-color-ink, #000000);
+    --rr-marp-ink: var(--rb-color-paper, #ffffff);
+  }
+}