What's new​

Comment Filter​

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

%% This will not appear on the website %%

%%
Neither will this
multi-line block
%%

Highlighting​

==highlighted text== 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.