Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/l1xnan/obsidian-better-export-pdf
Obsidian PDF export enhancement plugin
https://github.com/l1xnan/obsidian-better-export-pdf
obsidian-plugin pdf
Last synced: 3 months ago
JSON representation
Obsidian PDF export enhancement plugin
- Host: GitHub
- URL: https://github.com/l1xnan/obsidian-better-export-pdf
- Owner: l1xnan
- License: mit
- Created: 2023-08-20T10:32:19.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-04-12T16:18:44.000Z (10 months ago)
- Last Synced: 2024-04-14T01:05:48.908Z (10 months ago)
- Topics: obsidian-plugin, pdf
- Language: TypeScript
- Homepage:
- Size: 1.48 MB
- Stars: 173
- Watchers: 5
- Forks: 8
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- project-awesome - l1xnan/obsidian-better-export-pdf - Obsidian PDF export enhancement plugin (TypeScript)
README
# Obsidian Better Export PDF
English | [中文](./README.zh.md)
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
- 🌸Batch export multiple PDF files
- 🍬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`](obsidian://show-plugin?id=better-export-pdf).
### Manual installation
1. Download the .zip file from [the latest Release](https://github.com/l1xnan/obsidian-better-export-pdf/releases), 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](https://obsidian.md/plugins?id=obsidian42-brat).
## 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:
```html
/
```
See details [`.printToPDF(options)`](https://www.electronjs.org/docs/latest/api/webview-tag#webviewprinttopdfoptions).
It can be any HTML fragment, such as adding a base64 image:
```html
![]()
```
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:
```css
@media print {
body {
--font-interface-override: "Times New Roman" !important;
--font-text-override: "Times New Roman" !important;
--font-print-override: "Times New Roman" !important;
--font-monospace-override: "Consolas" !important;
--font-text-size: 20px !important;
font-family: "Times New Roman" !important;
}
}
```
### Select Disabled CSS Snippts
First, enable the `Select CSS snippets` option in the plugin configuration. This will allow you to see the `CSS snippets` option in the modal for exporting PDFs. From there, you can choose CSS snippets that have not been globally enabled in the `Appearance > CSS Fragments` section.
### 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:
```markdown
---
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.
### Folder batch export
Select the folder in the sidebar, right-click the menu `Export each file to PDF`, you can batch export each file of the entire folder to PDF file.
### 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
### Effect picture
## TODO
- [ ] Automatically adds internal link content to footnotes/appendices;
- [ ] Support pagedjs beautification;
- [x] Support print preview;
- [ ] Export multiple Markdown files into one PDF file;
- [ ] Improves default `@media print` css style;
- [x] Support add PDF metadata from front matter;
- [x] 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:
[PayPal](https://paypal.me/l1xnan) or [WeChat or Alipay](./README.zh.md#赞助)
---