README file from
GithubDocument Exporter
Export notes, folders, and filtered results into PDF, Word, Markdown bundles, and HTML documents.
Features
- PDF — generates a print-ready
.pdfwith native Obsidian rendering - Word document — generates a
.docxdocument for editing and sharing - Markdown bundle — combines selected notes into a single
.mdfile with copied attachments and rewritten links - HTML document — generates a standalone
.htmlwith table of contents, native rendering, and linked assets
Usage
Multiple ways to start an export:
| Entry point | How |
|---|---|
| Sidebar icon | Click the export icon in the left sidebar |
| Right-click a file | File explorer → right-click a Markdown file → "Export this file" |
| Right-click a folder | File explorer → right-click a folder → "Export this folder" |
| Right-click in editor | Right-click inside a note → "Export current file" |
| Command palette | Cmd/Ctrl+P → "Export documents" |
Export dialog
- Choose source — current file, folder, selected files, or tag filter
- Choose format — PDF, Word document, Markdown bundle, or HTML document
- Set output folder — type a path, click Vault to pick from vault folders, or Choose folder to select a system folder (desktop only)
- Set file name — defaults to the source file or folder name
- Click Next → review the summary → click Export
A notification shows the output path when export completes.
Examples
Export the current note as PDF
- Open a note → right-click → Export current file
- Format: PDF → click Export
- Result:
exports/<filename>.pdf
Export a folder as Markdown bundle
- Right-click a folder → Export this folder
- Format: Markdown bundle
- Click Export
- Result:
exports/<foldername>.md+exports/assets/(if images exist)
Export filtered notes as HTML
- Start an export from sidebar icon or command palette
- Source: Filter by tag, Format: HTML document
- Click Export
- Result: a standalone
.htmlwith all matched notes combined and a table of contents
Settings
Open Settings → Document Exporter.
| Setting | Description | Default |
|---|---|---|
| Output folder | Where exported files are saved | exports |
| Default export format | Format pre-selected when opening the dialog | |
| Default sort mode | How notes are ordered in the output | File path |
| Include source path comments | Add HTML comments showing each section's origin | Off |
| Copy attachments | Copy referenced images and files into the export | On |
| Overwrite existing exports | Overwrite if output already exists; otherwise a timestamped folder is created | Off |
Limitations
- Inline note embeds (
![[Note]]) are preserved as links, not expanded - Dataview queries are not executed during export
- Canvas files are not supported
- PDF export requires the desktop app
Privacy
Document Exporter does not make any network requests. All processing happens locally. No data is sent to external services.
Installation
Search "Document Exporter" in Settings → Community plugins → Browse and click Install.
Manual installation
Copy main.js, manifest.json, and styles.css into your vault's .obsidian/plugins/document-exporter/ directory.
Development
npm install
npm run dev # watch mode
npm run build # production build
npm test # run tests
License
MIT