Obsidian Better Export PDF 插件安装与使用教程

Obsidian Better Export PDF 插件安装与使用教程

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

1. 项目目录结构及介绍

obsidian-better-export-pdf 是一个用于增强 Obsidian 内置 PDF 导出功能的插件。以下是项目的基本目录结构：

.
├── README.md          // 主要说明文档
├── src                 // 源代码目录
│   └── main.ts         // 插件主入口文件
└── package.json        // 项目配置文件，包括依赖和版本信息

• src/main.ts: 这是插件的核心代码，它包含了所有的功能实现。
• package.json: 文件定义了项目元数据和依赖项。

2. 项目启动文件介绍

项目的启动文件是 src/main.ts。在这个文件中，你可以找到插件的核心逻辑，如导出预览、书签大纲、自定义页边距等功能的实现。它与 Obsidian 的 API 集成以提供增强的 PDF 导出体验。

例如，其中可能有注册命令（commands）和事件监听器（event listeners），以便在 Obsidian 中使用时触发相应的导出操作。

// 注册命令示例
export const command = app => {
    return {
        id: 'betterExportPdf',
        name: 'Better Export PDF',
        execute: async () => {
            // 导出相关操作在这里执行
            ...
        },
    };
};

// 添加事件监听器示例
app.commands.registerCommand(command);

3. 项目的配置文件介绍

该项目主要的配置文件是 package.json。这个文件定义了插件的元数据、依赖以及可选的脚本指令。以下是一些关键字段：

{
  "name": "obsidian-better-export-pdf",
  "version": "1.0.0",       // 插件版本号
  "description": "...",     // 插件描述
  "keywords": [...],        // 关键词标签
  "main": "./src/main.js",   // 入口文件（在构建后通常为编译后的 JavaScript）
  "dependencies": {...},   // 依赖包
  "devDependencies": {...}  // 开发阶段依赖
}

安装或更新插件时，Obsidian 将根据 package.json 中的依赖列表获取并安装所需的库。此外，开发者还可以在该文件中定义构建脚本，例如使用 TypeScript 编译源代码。

为了在 Obsidian 中安装此插件，可以遵循以下步骤：

1. 下载最新版本的 ZIP 包。
2. 解压缩到你的 Obsidian 笔记库中的 plugins 目录。
3. 重启 Obsidian 并启用插件。

完成后，用户可以通过插件菜单或者命令面板来使用 Better Export PDF 功能，比如添加页眉页脚、页码、导出多文件等。

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