Skip to content

Latest commit

 

History

History
153 lines (102 loc) · 4.7 KB

README.md

File metadata and controls

153 lines (102 loc) · 4.7 KB
Raw

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
  • 🎈Export multiple Markdown files(folder or specified files) into one PDF file
  • 🍬Support exporting PDFs in any size, and can export all content onto a single page
  • ... ...

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. Select export target:
    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.
  2. In the dialog box that is displayed, modify the configuration.
  3. Click Export, select the export path, and if you don't need to modify the configuration, you can directly press the Enter key to trigger the export operation.

Set the header and footer

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).

It can be any HTML fragment, such as adding a base64 image:

<div style="width: 100vw;font-size:10px;text-align:center;">
  <img height="10px" width="10px" src="data:image/svg+xml;base64,xxx..." />
  <span class="title"></span>
</div>

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

  • headerTemplate
  • footerTemplate

Customize the export style

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;
  }
}

Add PDF metadata

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

Export multiple Markdown files

Quick export

Select the folder in the sidebar, right-click the menu Export folder to PDF, you can export the entire folder contents to a PDF file.

Note: This does not guarantee the file export order.

Custom export

Create a new table of contents note, add something like the following, need to add a toc: true document property:

---
toc: true
---

## Table of Contents

[[Note1|Title1]]
[[Note2]]
[[Note2]]

This allows the plugin to export the notes in the order of the internal links. The anchor point of the exported PDF table of contents supports clicking to jump.

Export as One Page

In the export dialog, select Custom for Page Size and set Margin to None. Set the page size according to the document's requirements.

Preview

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: