【亲测免费】 Obsidian Pandoc 插件使用教程

1. 项目目录结构及介绍

Obsidian Pandoc 插件的目录结构如下：

obsidian-pandoc/
├── .github/
│   └── workflows/
├── .gitignore
├── CHANGELOG.md
├── LICENSE.md
├── README.md
├── command-palette.png
├── development.md
├── esbuild.config.mjs
├── global.ts
├── main.ts
├── manifest.json
├── package.json
├── pandoc.ts
├── renderer.ts
├── settings.ts
├── styles.css
├── tsconfig.json
└── versions.json

目录结构介绍

• .github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• .gitignore: 指定 Git 忽略的文件和目录。
• CHANGELOG.md: 记录项目的变更日志。
• LICENSE.md: 项目的开源许可证文件。
• README.md: 项目的介绍和使用说明。
• command-palette.png: 命令面板的截图。
• development.md: 开发相关的文档。
• esbuild.config.mjs: esbuild 的配置文件。
• global.ts: 全局配置文件。
• main.ts: 项目的主入口文件。
• manifest.json: 插件的清单文件，包含插件的基本信息。
• package.json: 项目的依赖管理文件。
• pandoc.ts: Pandoc 相关的逻辑文件。
• renderer.ts: 渲染相关的逻辑文件。
• settings.ts: 插件的设置逻辑文件。
• styles.css: 插件的样式文件。
• tsconfig.json: TypeScript 的配置文件。
• versions.json: 版本管理文件。

2. 项目的启动文件介绍

项目的启动文件是 main.ts。这个文件是 Obsidian Pandoc 插件的主入口，负责初始化插件并注册相关的命令和事件。

main.ts 文件内容概述

• 初始化插件: 在 main.ts 中，首先会初始化插件，并注册插件的基本信息。
• 注册命令: 插件会注册一些命令，这些命令可以通过 Obsidian 的命令面板调用。
• 事件监听: 插件会监听 Obsidian 的一些事件，以便在特定事件发生时执行相应的操作。

3. 项目的配置文件介绍

manifest.json

manifest.json 是 Obsidian 插件的清单文件，包含插件的基本信息，如插件的 ID、名称、版本号、作者等。

{
  "id": "obsidian-pandoc",
  "name": "Pandoc Plugin",
  "version": "1.0.0",
  "minAppVersion": "0.12.0",
  "description": "A Pandoc export plugin for Obsidian.",
  "author": "Oliver Balfour",
  "authorUrl": "https://github.com/OliverBalfour",
  "isDesktopOnly": false
}

package.json

package.json 是 Node.js 项目的依赖管理文件，包含项目的依赖包、脚本命令等信息。

{
  "name": "obsidian-pandoc",
  "version": "1.0.0",
  "description": "A Pandoc export plugin for Obsidian.",
  "main": "main.ts",
  "scripts": {
    "build": "esbuild main.ts --bundle --outfile=main.js --platform=node --target=node12"
  },
  "author": "Oliver Balfour",
  "license": "MIT",
  "dependencies": {
    "obsidian": "^0.12.0"
  }
}

tsconfig.json

tsconfig.json 是 TypeScript 的配置文件，用于配置 TypeScript 编译器的选项。

{
  "compilerOptions": {
    "module": "commonjs",
    "target": "es6",
    "outDir": "./dist",
    "rootDir": "./src",
    "strict": true
  }
}

通过以上介绍，您可以更好地理解 Obsidian Pandoc 插件的目录结构、启动文件和配置文件。希望这篇教程对您有所帮助！