Typst PDF Export

Export Obsidian notes to PDF using the Typst typesetting system. Supports customizable templates, batch processing, and advanced formatting options.

Table of Contents

• Key Features
• Why Typst?
• Installation
• Quick Start
• Configuration
• Requirements
• Templates
• Advanced Usage
• Known Limitations
• Troubleshooting
• Development
• Contributing
• License

Key Features

• 🎨 Multiple Templates: Choose from built-in templates (default, modern, article, report) or create custom ones
• 📁 Batch Export: Export entire folders of notes with a single click
• 🖼️ Media Support: Smart handling of embedded images and PDFs
• 📎 File Embedding: Embed any file type as attachments in the output PDF
• ⚡ Real-time Progress: Visual progress tracking with cancellation support
• 🔧 Advanced Configuration: Comprehensive export options including typography, layout, and behavior settings
• 🔍 Font Discovery: Automatic system font detection and caching
• 🛡️ Security First: Path validation and sanitization for safe operations
• 📐 Professional Layout: Paper sizes, margins, typography controls, and more
• 📧 Email Block Support: Supports the YAML Email Block format introduced by the Email Block plugin

Why This Plugin?

This plugin was born from frustration with Obsidian's native PDF export, which simply renders notes using the current Obsidian theme. While functional, this approach lacks the professional typesetting quality needed for serious documents.

The immediate catalyst came from a practical need: my wife required single-page PDFs – documents where the page grows to accommodate all content without pagination breaks. This format is ideal for digital preservation and viewing, keeping everything in one continuous, scrollable document. The native export couldn't provide this. By leveraging Typst's powerful typesetting engine, this plugin delivers:

• Professional Quality: Properly typeset documents that look publication-ready, not just screenshots of notes
• Flexible Page Sizing: Create single-page PDFs that expand to fit all content – perfect for digital preservation and continuous reading
• True Separation of Concerns: Content and styling are properly separated, following best practices in document preparation
• Consistent Output: Documents that look good by default, without requiring theme tweaking

This transforms Obsidian from a note-taking tool into a complete document preparation system, bridging the gap between quick notes and professional output.

Why Typst?

Typst offers several advantages over standard PDF export:

• Superior typography with advanced font handling and mathematical typesetting
• Flexible layouts with multi-column support and custom headers/footers
• Fast compilation compared to LaTeX
• Clean, readable markup syntax
• Publication-quality output

Installation

Method 1: Community Plugin Store (Recommended) - Still waiting on plugin approval

1. Open Settings → Community Plugins
2. Disable Safe Mode if needed
3. Click Browse and search for "Typst PDF Export"
4. Install and Enable the plugin

Method 2: Manual Installation from GitHub Releases

⚠️ Important: This plugin requires template files to function. Always use the complete ZIP package.

1. Go to GitHub Releases
2. Download the complete ZIP package (typst-pdf-export.zip) - NOT just main.js
3. Extract the entire contents to {VaultFolder}/.obsidian/plugins/typst-pdf-export/
4. Ensure the templates/ directory is included with all .typ files:

   .obsidian/plugins/typst-pdf-export/
   ├── main.js
   ├── manifest.json
   ├── styles.css
   └── templates/
       ├── default.typ
       ├── modern.typ
       ├── article.typ
       ├── report.typ
       └── universal-wrapper.pandoc.typ
   

5. Reload Obsidian (Ctrl/Cmd + R or restart)
6. Enable the plugin in Settings → Community Plugins

Method 3: BRAT (Beta Reviewer's Auto-update Tool)

1. Install the BRAT plugin
2. Add this repository: https://github.com/AlexKucera/obsidian-typst-pdf-export
3. Enable the plugin after installation

Method 4: Developer Installation

For development or the latest changes:

1. Clone the repository to your vault's plugins folder:

   cd {VaultFolder}/.obsidian/plugins/
   git clone https://github.com/AlexKucera/obsidian-typst-pdf-export.git typst-pdf-export
   cd typst-pdf-export
   

2. Install dependencies and build:

   npm install
   npm run build
   

3. Reload Obsidian and enable the plugin

Troubleshooting Installation

Plugin doesn't work after manual installation?

• Verify the templates/ directory exists with all .typ files
• Check the browser console (F12) for error messages
• Try downloading the complete ZIP package again

Missing templates error?

• The plugin automatically extracts embedded templates if missing
• Check Settings → Community Plugins → Typst PDF Export for status

Quick Start

1. Install Dependencies

Required:

• Pandoc 3.7.0+ - Markdown to Typst conversion
• Typst 0.13.0+ - PDF generation
• ImageMagick 7.1.2+ - Enhanced image processing

2. Export Your First Note

1. Open any note in Obsidian
2. Click the Typst Export ribbon icon or use Ctrl/Cmd + P → "Export to Typst PDF"
3. Configure your export settings in the modal
4. Click Export and select your output location

3. Verify Installation

Go to the plugin settings and click Check Dependencies to ensure all required tools are properly installed.

Configuration

Export Options

Templates

• Default: Clean, minimal design suitable for most documents
• Modern: Contemporary styling with accent colors and modern typography
• Article: Academic paper format with proper spacing and citations
• Report: Business/technical report format with structured sections

Requirements

System Requirements

• Obsidian: Version 1.9.12 or higher
• Platform: Desktop only (Windows, macOS, Linux) - I develop this on macOS, but it should in theory work on Windows and Linux. I just have no way to test it.
• Node.js: Version 18.20+ (for development)

External Dependencies

Note: The plugin will display warnings if your installed versions are below the minimum requirements. While older versions may work, they are not officially supported and may cause compatibility issues.

Dependency Verification

The plugin includes an automated dependency checker accessible through:

• Plugin settings → Check Dependencies
• Export modal → Dependency Status indicator

Templates

Built-in Templates

1. Default Template (default.typ)

   • Clean, minimal design
   • Perfect for notes and documentation
   • Supports all basic formatting

2. Modern Template (modern.typ)

   • Contemporary styling with accent colors
   • Enhanced typography and spacing
   • Great for presentations and reports

3. Article Template (article.typ)

   • Academic paper formatting
   • Proper citation handling
   • Structured section layouts

4. Report Template (report.typ)

   • Business/technical document format
   • Professional styling
   • Multi-section organization

Custom Templates

Create your own Typst templates by:

1. Adding .typ files to the plugin's templates/ directory
2. Including template metadata at the top of your file
3. Following the Typst template structure

Advanced Usage

Folder Export

Export multiple notes at once:

1. Right-click on any folder in the file explorer
2. Select Export Folder to Typst PDF
3. Configure batch export settings
4. Monitor progress in the export modal

Embedded Media Handling

The plugin automatically processes:

• Images: PNG, JPG, GIF, WebP formats
• PDFs: Converted to images for Typst inclusion
• Links: Properly formatted in the output PDF
• Math: LaTeX math expressions rendered correctly

Email Blocks

Format them like this:

```email
to: [email protected]
subject: Hello World
---
Hi there,
this is my new body
Best!
JB
```

Known Limitations

This plugin works by converting your Markdown notes to PDF through a static conversion pipeline (Markdown → Typst → PDF). Due to this design, certain Obsidian features that generate or modify content dynamically cannot be exported:

Dynamic Content Plugins

DataView Plugin: Queries and dynamically generated tables/lists from DataView will not appear in the exported PDF. DataView evaluates queries at runtime within Obsidian, but the plugin exports the raw Markdown source before this evaluation occurs.

Database/Query Plugins: Similar to DataView, any plugin that generates content through database queries or dynamic rendering will not be included in the export. This includes:

• Core Properties/Bases plugin
• Database folder plugin
• Any query-based content generation

Custom Syntax & Styling

Plugin-Specific Syntax: Plugins that introduce custom Markdown syntax extensions will not translate to the PDF unless Pandoc explicitly supports that syntax. The conversion pipeline relies on Pandoc's understanding of Markdown, which may not recognize plugin-specific extensions.

Custom Styling: Visual styling applied by themes or plugins (such as callout styling, custom CSS classes, or plugin-specific formatting) will not be preserved. The PDF output uses Typst templates for styling, which are independent of Obsidian's rendering engine.

Workarounds

For content you need in the exported PDF:

1. Manual Inclusion: Copy DataView query results into static Markdown before exporting
2. Preprocessing: Create a separate note with materialized content for export
3. Alternative Formatting: Use standard Markdown features that Pandoc and Typst support natively

Troubleshooting

Common Issues

Debug Steps

1. Check Dependencies: Use the built-in dependency checker
2. Console Logs: Open Developer Tools (Ctrl/Cmd+Shift+I) for error details
3. Test Manually: Try running Pandoc/Typst commands directly in terminal
4. Clear Cache: Reset plugin settings if needed
5. Clean Install: Remove and reinstall the plugin

Getting Help

• Issues: Report bugs on GitHub Issues
• Discussions: Join conversations in GitHub Discussions
• Documentation: Check the plugin's settings for inline help

Development

Setup

# Clone the repository
git clone https://github.com/akucera/obsidian-typst-pdf-export.git typst-pdf-export
cd typst-pdf-export

# Install dependencies
npm install

# Start development server
npm run dev

Project Structure

typst-pdf-export/
├── src/
│   ├── core/              # Core system components
│   ├── converters/        # Conversion pipeline
│   ├── ui/               # User interface components
│   ├── templates/        # Template management
│   └── utils/            # Utility functions
├── templates/            # Built-in Typst templates
├── main.ts              # Plugin entry point
└── manifest.json        # Plugin metadata

Build Commands

npm run dev      # Development with file watching
npm run build    # Production build with type checking
npm run version  # Version bump and manifest update

Architecture

The plugin follows a modular architecture with:

• Conversion Pipeline: Markdown → Typst → PDF via Pandoc
• Template System: Dynamic template loading and management
• Security Layer: Path validation and sanitization
• Progress Tracking: Real-time feedback with cancellation support

Development Philosophy

This plugin was developed using vibe coding techniques with AI assistance, but with crucial safeguards to prevent AI slop. Unlike typical vibe coding where code is generated without detailed review, this project employed strict quality control measures:

AI-Assisted Development with Human Oversight

• Controlled Generation: While large portions of code were AI-generated, every function was reviewed and validated
• Slop Prevention Tools: Used specialized tools like slopwatch and vibe-check to catch and prevent low-quality patterns
• Systematic Review: All AI suggestions were filtered through domain expertise and architectural consistency checks
• Test-Driven Validation: Comprehensive testing ensured generated code met production standards

Quality Control Measures

• Pattern Enforcement: AI was guided by strict architectural patterns and coding standards
• Memory Management: Used persistent context tools to maintain consistency across development sessions
• Iterative Refinement: Code went through multiple review-refactor cycles to eliminate "code smell"
• Human Decision Making: Critical design decisions and architecture remained under human control

This approach allowed rapid development while maintaining the code quality expected of a production Obsidian plugin. The result is clean, maintainable code that leverages AI's productivity benefits without sacrificing quality or introducing the technical debt typically associated with pure vibe coding.

Contributing

Contributions are welcome.

Development Guidelines

1. Fork the repository
2. Create a feature branch: git checkout -b feature/amazing-feature
3. Follow TypeScript and ESLint conventions
4. Test your changes thoroughly in Obsidian
5. Commit with descriptive messages: git commit -m 'feat: add amazing feature'
6. Push to your branch: git push origin feature/amazing-feature
7. Submit a Pull Request

Code Style

• Follow existing TypeScript patterns and conventions
• Use meaningful variable and function names
• Add comments for complex logic
• Ensure proper error handling
• Write modular, testable code

License

This project is licensed under the GNU GPL v3.0 License - see the LICENSE file for details.

Third-Party Licenses

This plugin uses the following dependencies:

• gray-matter (MIT License) - YAML front matter parsing
• pdf-to-img (MIT License) - PDF to image conversion

Support

If you find this plugin helpful, consider supporting its development:

Contact

Author: Alexander Kucera
Website: alexanderkucera.com
GitHub: @AlexKucera

If this plugin helped you, please consider giving it a star on GitHub.