Skip to content

l1xnan/obsidian-better-export-pdf

Repository files navigation

Obsidian Better Export PDF

English | 中文

Better Export PDF is an Obsidian PDF export enhancement plugin that adds the ability to export bookmarks outline, export preview and add page numbers to PDF compared to the official PDF export function.

Features

Compared to the official Export PDF feature:

  • 🚀Support export preview
  • 🎉Export the outline bookmarks
  • 🛩️Customize the margins
  • ✨Export the page numbers
  • 💥Support add PDF metadata from front matter;
  • 🎇Export internal links within file;
  • ... ...

Installation

In Obsidian go to Settings > Third-party plugins > Community Plugins > Browse and search for Better Export PDF.

Manual installation

  1. Download the .zip file from the latest Release, or from any other release version.
  2. Unzip into: {VaultFolder}/.obsidian/plugins/
  3. Reload Obsidian and enable the plug-in.

or use the BRAT Plugin.

Usage

  1. In the upper right corner of the current Markdown view, click More options and select Better Export PDF;
  2. Open the command panel and select Better Export PDF: Export Current File to PDF.

If the exported PDF page is abnormal, trying to change the color in the appearance will switch to a light color.

Settings

Set page numbers using the Header Template and Footer Template, for example:

<div style="width: 100vw;font-size:10px;text-align:center;">
    <span class="pageNumber"></span> / <span class="totalPages"></span>
</div>

See details <webview>.printToPDF(options).

If you want to further customize the PDF export style, you can add custom CSS in the Appearance > CSS Snippet, such as custom fonts and sizes:

@media print {
  body {
    font-size: 20px !important;
    font-family: "Times New Roman" !important;
  }
}

frontMatter

PDF Metadata can be added to through frontMatter of the configuration document. Supported field items are:

  • title
  • author
  • keywords
  • created_at
  • updated_at
  • creator
  • producer

Document level header/footer templates can also be configured in frontMatter:

  • headerTemplate
  • footerTemplate

Export preview

Export preview

Effect picture

Export preview

TODO

  • Automatically adds internal link content to footnotes/appendices;
  • Support pagedjs beautification;
  • Support print preview;
  • Export multiple Markdown files into one PDF file;
  • Improves default @media print css style;
  • Support add PDF metadata from front matter;
  • Export internal links within file;

Support This Plugin

This plugin takes a lot of work to maintain and continue adding features. If you want to fund the continued development of this plugin you can do so here: