What's new​

Headless Conversion via Local REST API​

Two Obsidian commands are now exposed that can be called via the Local REST API plugin:

Status File for Polling​

After every run (or attempt) the plugin writes a status file to .obsidiosaurus/last-run.json inside the vault. Agents can poll this file to check completion and pick up errors.

{
  "status": "running" | "success" | "error",
  "startedAt": "2026-05-16T11:52:20.051Z",
  "finishedAt": "2026-05-16T11:52:20.064Z",
  "filesToProcess": 1,
  "filesToDelete": 1,
  "error": { "message": "...", "stack": "..." },
  "version": "1.2.0"
}

Counts (filesToProcess, filesToDelete) reflect the change-preview snapshot taken before the run, not necessarily the exact number of files written.

Example Agent Workflow​

API_KEY="<your local-rest-api key>"

# 1. Trigger the build (returns immediately)
curl -sk -X POST -H "Authorization: Bearer $API_KEY" \
  https://localhost:27124/commands/obsidiosaurus:run/

# 2. Poll status until done
curl -sk -H "Authorization: Bearer $API_KEY" \
  https://localhost:27124/vault/.obsidiosaurus/last-run.json

What's new​

Comment Filter​

Obsidian comments (``) are now stripped during conversion — both inline and multi-line block comments.

Highlighting​

<mark>highlighted text</mark> is converted to <mark>highlighted text</mark>, which renders with native browser highlight styling.

Mermaid Diagrams​

Mermaid code blocks are passed through to Docusaurus. Requires @docusaurus/theme-mermaid in your Docusaurus config:

themes: ['@docusaurus/theme-mermaid'],
markdown: { mermaid: true }

Supported diagram types: flowchart, sequence, class, gantt, pie — and all other Mermaid types.

Already working (no conversion needed)​

• Footnotes ([^1]) — handled natively by MDX
• Task lists (- [ ] / - [x]) — handled natively by MDX

Bug Fix​

• <mark> at the start of a line is now prefixed with {''} to prevent MDX 2 from parsing the paragraph as a block-level JSX element

What's new​

Codebase​

• TypeScript upgraded from 4.7 to 5.4
• mainProcessor.ts refactored from 1021 lines into dedicated modules: fileScanner.ts, fileInfoBuilder.ts, changeTracker.ts, assetProcessor.ts
• pino logger replaced with console (no more Node-only dependency in Electron)
• GraphicsMagick (gm) replaced with Canvas API — no system dependency required
• augmentPathForMacOS() removed — cross-platform by default

Docusaurus v3 Compatibility​

• Output changed from .md to .mdx
• Admonition syntax updated to v3 format: :::note[Title]
• future: { v4: true } compatible — .md treated as CommonMark, .mdx as MDX

Bug Fixes​

• #13 / #18 — Asset filenames with leading digits were corrupted during sanitization
• #14 — ENOENT crash when copying assets for modified files (stale assetJson entries)
• #16 — Renamed files left orphan pages in the output
• [!QUOTE] callout now correctly converted to blockquote

Plugin Setup​

• vaultPath is now read dynamically from Obsidian (vault.adapter.getBasePath()) — no more hardcoded "vault" folder name
• Released as BRAT-installable plugin with main.js, manifest.json, styles.css attached

Tests​

• 33 tests covering markdownProcessor, fileInfoBuilder, changeTracker, assetProcessor

Test

What is currently supported?​

General​

• Documentation: ✅
• Blog: ✅
• Multiple Blogs: ✅
• Localisation i18n: ✅
• Multiple Sidebars: ✅

Standard Formating​

• Links: ✅
• Tables: ✅
• Admonitions/Callouts: ✅
• Quotes: ✅
• iFrames: ✅
• Codeblocks: ✅
• Head Metadata: ✅
• Checklists: ✅

Assets​

• Images: ✅ (.png & .svg)
  • Image resize: ✅
  • Image converter: ✅ (.webp)
• File download: ✅ (.pdf, .docx, ..)

Drawings & Diagrams​

• Excalidraw: ✅ (light & dark mode)
• diagrams.net ✅ (light & dark mode)
• Math Equations: ✅ (with Docusaurus Plugin)
• Mermaid: ✅ (with Docusaurus Plugin)

Known Issues:​

When renaming files and folders in Obsidian, it doesn't delete the outdated files from your Docusaurus files.