README file from
GithubDOCX Exporter Plus
Obsidian plugin that exports the active Markdown note directly to .docx, and also offers Pandoc export for citation-heavy notes plus assembled Longform project export, targeting the common subset that opens cleanly in Microsoft Word, Apple Pages, and Google Docs.
What it does:
- Maps Markdown headings to standard DOCX heading levels so the document stays structured across Word, Pages, and Google Docs.
- Preserves clickable links.
- Reads rendered text colors from Obsidian and adjusts overly light text so it stays readable on white paper.
- Exports embedded images and Markdown note embeds.
- Converts image captions into plain numbered caption paragraphs for better cross-app compatibility.
- Writes the exported
.docxnext to the source note. - Adds Pandoc export commands for both the active note and assembled Longform projects.
Current scope:
- Exports paragraphs, headings, lists, code blocks, horizontal rules, basic tables, images, and embedded Markdown notes.
- Uses Obsidian's renderer before conversion, which helps preserve rendered links and inline styling.
- Rasterizes SVG and WebP images to PNG in the exported DOCX because that format imports more reliably into Pages and Google Docs.
- Non-Markdown media embeds such as PDFs/audio/video currently export as file reference links rather than inline media.
- The Pandoc export path strips PDF Scholia Scribe's managed reference block, preserves ordinary
@citekeycitations, and converts PDF Scholia vault/Zotero citation links into Pandoc citations when a citekey can be resolved. - Longform project export assembles scenes in project order, removes scene frontmatter, carries project frontmatter into the manuscript, and turns scene titles into Markdown headings before running Pandoc.
Build:
npm install
npm run build
Manual install for local testing:
.obsidian/plugins/docx-exporter-plus
Copy these files into that folder:
main.jsmanifest.jsonstyles.css
Community release notes:
- The GitHub release tag must match the
versioninmanifest.json. - Release assets should include
main.js,manifest.json, andstyles.css.
Future releases:
git tag <version>
git push origin <version>
That tag triggers the GitHub Actions release workflow, which rebuilds the plugin, uploads the release assets, and generates GitHub artifact attestations for them.
Pandoc export:
- Command:
Export active note with Pandoc - Command:
Export Longform project with Pandoc - Requires a local
pandocinstall. - Best for academic notes that use Pandoc-style citations or PDF Scholia source notes with
citekeymetadata. - The Longform command works from either a Longform index note or one of its scene notes and assembles the manuscript directly from the project scene list.
- You only need Longform's own Compile step first if you rely on custom Longform compile transformations beyond simple scene assembly.
- Optional global Pandoc defaults, bibliography, CSL, and reference DOCX paths can be configured in the plugin settings.