obsidian2epub

Convert Obsidian vaults to EPUB ebooks. Use when the user wants to create an ebook from Obsidian notes, export a vault as EPUB, or convert markdown notes to an ebook format.

⭐5stars🔀1forks📁View on GitHub🕐Updated Jan 11, 2026⬇️1downloads

When & Why to Use This Skill

Obsidian2Epub is a specialized Claude skill that automates the conversion of Obsidian vaults and Markdown notes into professionally structured EPUB ebooks. It ensures high-fidelity exports by preserving internal wikilinks, rendering Mermaid diagrams into SVGs, and applying smart chapter ordering, making it the ideal tool for transforming digital knowledge bases into portable, e-reader-ready formats.

Use Cases

  • Offline Knowledge Consumption: Convert your entire Obsidian personal knowledge base into an EPUB for comfortable, distraction-free reading on Kindle, Kobo, or mobile devices.
  • Technical Documentation Publishing: Export complex technical notes containing Mermaid diagrams and cross-references into a single, navigable ebook for team distribution or archival.
  • Curated Content Compilation: Use the MOC (Map of Content) and regex filtering features to select specific folders and define a custom chapter sequence for a curated ebook project.
  • Academic and Research Portability: Transform research notes and citations into a well-organized ebook format, maintaining the integrity of internal links and visual diagrams.
nameobsidian2epub
descriptionConvert Obsidian vaults to EPUB ebooks. Use when the user wants to create an ebook from Obsidian notes, export a vault as EPUB, or convert markdown notes to an ebook format.

Obsidian2Epub

Convert Obsidian vaults to well-structured EPUB ebooks with full support for wikilinks, attachments, and Mermaid diagrams.

Quick Start

scripts/convert.sh /path/to/vault -o output.epub

Instructions

  1. Get the vault path from the user
  2. Determine output EPUB path
  3. Ask about optional settings (title, author, theme, filters)
  4. Run the conversion using scripts/convert.sh
  5. Report any warnings (unresolved links, mermaid failures)

CLI Reference

# Basic conversion
scripts/convert.sh /path/to/vault -o book.epub

# With options
scripts/convert.sh /path/to/vault \
  -o book.epub \
  --title "Book Title" \
  --author "Author Name" \
  --moc "Index.md" \
  -d  # dark Flexoki theme

# Interactive TUI
scripts/convert.sh --tui

Options

Option Description
-o, --output Output EPUB path (required)
--title Book title (default: vault name)
--author Author name
--moc MOC file for chapter ordering
-d, --dark Dark Flexoki theme
--include Regex to include files
--exclude Regex to exclude files
--tui Launch interactive TUI

Features

  • Wikilinks: [[note]] becomes internal EPUB links
  • Mermaid: Rendered to SVG (requires npm install -g @mermaid-js/mermaid-cli)
  • Smart Ordering: HITS algorithm for chapter order
  • Flexoki Themes: Light (default) and dark

Examples

Convert with custom title:

scripts/convert.sh ~/Obsidian/MyVault -o mybook.epub --title "My Knowledge Base"

Include only specific folders:

scripts/convert.sh ~/Obsidian/MyVault -o book.epub --include "^Projects/"

Exclude drafts:

scripts/convert.sh ~/Obsidian/MyVault -o book.epub --exclude "^Drafts/"

Configuration

Set OBSIDIAN2EPUB_DIR environment variable to override the default installation path:

export OBSIDIAN2EPUB_DIR=/path/to/obsidian2epub

Troubleshooting

Mermaid not rendering: Install mermaid-cli: npm install -g @mermaid-js/mermaid-cli

Unresolved wikilinks: Links to notes not in vault are reported as warnings

Missing attachments: Ensure files exist and paths are correct in notes