README file from
GithubDocx Styler
Export Obsidian notes to Word (.docx) files that use real Word styles. Works on desktop and mobile. No Pandoc or other software to install.
What you get for free
- Export the current note from the command palette, the ribbon, or a file's right-click menu.
- Headings become Word's Heading 1 to 6, so the Word navigation pane and table of contents work.
- Bold, italic, strikethrough, highlights, inline code and links.
- Bulleted, numbered, nested and task lists.
- Tables, block quotes, callouts and code blocks.
- Embedded vault images (
![[image.png|300]]keeps the width). - Footnotes become real Word footnotes.
- Wikilinks become their display text. Properties and
%%comments%%are left out. - A4 or Letter pages, your choice of font and size, files saved into your vault.
The free features never use the network and never stop working.
Pro
Pro adds:
- Your own Word template. Point Docx Styler at a .docx in your vault and every export, single note or compiled folder, uses its styles (fonts, colors, spacing, heading looks).
- Page numbers in the footer.
- Compile a folder into one Word file. Run Compile a folder into one Word file (Pro) from the command palette, or right-click a folder and choose Compile to one Word file (.docx). Every note in the folder and its subfolders is joined in natural name order (Chapter 2 comes before Chapter 10) and saved as one .docx. Each note name becomes a Heading 1 chapter on a new page, headings inside a note move down one level, and your Word template and page numbers apply to the whole file. Properties and comments are left out, as in a single export.
- Cover page. Turn on Cover page and every export, single note or compiled folder, starts with a cover: the title, an optional subtitle and an optional author line, then a page break. The title is the note name (or the folder name for a compiled folder). A
title,subtitleorauthorproperty in the note overrides it, and Cover subtitle and Cover author in settings fill in the rest. For a compiled folder, the properties come from the folder note, a note with the same name as the folder inside it. The cover uses Word's Title and Subtitle styles (the author line uses a "Cover author" style based on Subtitle), so your Word template styles it. - Table of contents. Turn on Table of contents to add a real Word table of contents after the cover, built from the heading styles (levels 1 to 3 by default, set Table of contents levels from 1 to 6). Its title uses Word's TOC Heading style. It already lists your headings when the file opens, and Word refreshes it with page numbers when you open the file. Works for single notes and compiled folders.
- Both are off by default. To turn one on or off for a single note, add the property
docx-coverordocx-tocwithtrueorfalse.
Price: 19 USD, one-time. Use your key on up to 5 devices.
Buy Docx Styler Pro on Gumroad. Your license key is in the Gumroad receipt email.
After buying, paste your key into Settings > Docx Styler > License key and click Activate.
The license check is in this public code, so anyone could remove it. Buying a key is how you support the plugin and keep it maintained.
Payment and network use
- Payment is required for full access. Pro features need a license key sold through Gumroad.
- Network use. The plugin contacts only Gumroad's license verify API (
api.gumroad.com), and only when you click Activate or Check license, to check your key. No telemetry, no ads, and remote images are not downloaded.
Installation
- From Community plugins: open Settings > Community plugins > Browse, search for "Docx Styler", then install and enable it.
- Manually: download
main.js,manifest.jsonandstyles.cssfrom the latest release and copy them into<your vault>/.obsidian/plugins/docx-styler/. Then reload Obsidian and enable Docx Styler under Settings > Community plugins.
Support
Found a bug or have an idea? Open an issue on GitHub. For license key problems, open an issue without posting your key.
Known limits
- A Word template must already contain the styles you want to change (for example Heading 1). Word only saves a style into a file after it has been used or modified there.
- Footnote definitions must be on one line.
- Word asks whether to update the fields in the document when it opens a file with a table of contents. Click Yes to fill in the page numbers. LibreOffice shows the entries without page numbers until you choose Tools > Update > Update All.
- Note embeds (
![[Other note]]) are shown as a label, not inlined. SVG and WebP images are shown as a label.
Development
npm install
npm run build # type check and bundle to main.js
npm test # unit tests (vitest)
npm run lint # Obsidian's official eslint rules
License
MIT. See LICENSE.