Obsidian Better Export PDF 插件安装与配置指南

Obsidian Better Export PDF 插件安装与配置指南

obsidian-better-export-pdf Obsidian PDF export enhancement plugin 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-better-export-pdf

1. 项目基础介绍和主要编程语言

项目基础介绍

Obsidian Better Export PDF 是一个 Obsidian 笔记应用的增强插件，旨在提供比官方 PDF 导出功能更丰富的导出选项。该插件支持导出预览、PDF 大纲书签、自定义页边距、页码添加、PDF 元数据添加等功能。

主要编程语言

该项目主要使用以下编程语言和工具：

• TypeScript: 主要编程语言，用于编写插件的核心逻辑。
• JavaScript: 辅助编程语言，用于处理一些动态内容。
• CSS: 用于样式定制和页面布局。

2. 项目使用的关键技术和框架

关键技术和框架

• Obsidian API: 用于与 Obsidian 笔记应用进行交互。
• Electron: 用于处理 PDF 导出和预览功能。
• esbuild: 用于打包和构建插件。
• eslint: 用于代码质量检查。
• prettier: 用于代码格式化。

3. 项目安装和配置的准备工作和详细安装步骤

准备工作

1. 安装 Obsidian: 确保你已经安装并配置好了 Obsidian 笔记应用。
2. 安装 Node.js: 确保你的系统上已经安装了 Node.js 和 npm（Node.js 的包管理工具）。

详细安装步骤

步骤 1：下载插件

1. 打开 Obsidian 应用。
2. 进入设置（Settings）。
3. 在左侧菜单中选择“第三方插件”（Third-party plugins）。
4. 点击“浏览”（Browse）按钮，搜索“Better Export PDF”。
5. 找到插件后，点击“安装”（Install）按钮。

步骤 2：启用插件

1. 安装完成后，返回“第三方插件”页面。
2. 找到“Better Export PDF”插件，并点击“启用”（Enable）按钮。

步骤 3：配置插件

1. 启用插件后，你可以在 Obsidian 的命令面板中找到“Better Export PDF: Export Current File to PDF”命令。
2. 通过该命令，你可以选择导出当前文件为 PDF，并在弹出的对话框中进行配置。
3. 你可以设置页眉和页脚，例如添加页码：

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

4. 你还可以通过前言（frontMatter）配置文档级别的页眉和页脚模板。

步骤 4：自定义导出样式

1. 如果你想进一步自定义 PDF 导出样式，可以在“外观”（Appearance） > “CSS 片段”（CSS Snippet）中添加自定义 CSS。
2. 例如，你可以设置自定义字体和大小：

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

步骤 5：添加 PDF 元数据

1. 你可以在配置文档的前言（frontMatter）中添加 PDF 元数据，支持的字段包括：

   title: "文档标题"
   author: "作者"
   keywords: "关键词"
   created_at: "创建时间"
   updated_at: "更新时间"
   creator: "创建者"
   producer: "生产者"
   

通过以上步骤，你就可以成功安装并配置 Obsidian Better Export PDF 插件，享受更丰富的 PDF 导出功能。

obsidian-better-export-pdf Obsidian PDF export enhancement plugin 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-better-export-pdf