Obsidian Math Plus 项目启动与配置教程

1. 项目目录结构及介绍

Obsidian Math Plus 是一个为 Obsidian 编辑器增加数学公式支持的开源项目。以下是项目的目录结构及其简单介绍：

obsidian-math-plus/
├── .github/              # GitHub 相关的文件和目录
│   └── workflows/        # GitHub Actions 工作流文件
├── .vscode/              # VSCode 项目配置文件
├── assets/               # 项目资源文件
├── images/               # 项目图片文件
├── packages/             # 项目依赖的包文件
├── src/                  # 源代码目录
│   ├── main.ts           # 主程序文件
│   ├── styles/           # 样式文件
│   └── utils/            # 工具函数目录
├── test/                 # 测试文件目录
├── README.md             # 项目说明文件
└── package.json          # 项目配置文件

• .github/: 存放与 GitHub 相关的配置文件，如自动化工作流程。
• .vscode/: 存放 Visual Studio Code 的项目配置。
• assets/: 存放项目所需的资源文件，如图片、字体等。
• images/: 存放项目使用的图片文件。
• packages/: 存放项目依赖的第三方库。
• src/: 源代码目录，包括主程序文件和相关的样式、工具函数等。
• test/: 测试文件目录，用于存放单元测试和集成测试。
• README.md: 项目说明文件，介绍项目的功能、如何安装和使用等。
• package.json: Node.js 项目配置文件，定义项目依赖、脚本等。

2. 项目的启动文件介绍

项目的启动文件位于 src/main.ts。这是 TypeScript 编写的主程序文件，负责初始化插件、注册命令和处理 Obsidian 的事件。

import { Plugin } from 'obsidian';

export default class MathPlusPlugin extends Plugin {
  async onload() {
    // 插件初始化代码
  }

  async onunload() {
    // 插件卸载代码
  }
}

在 onload 方法中，你可以注册各种事件处理器，如注册自定义命令、设置快捷键等。而在 onunload 方法中，则需要清理这些事件处理器，避免内存泄漏。

3. 项目的配置文件介绍

项目的配置文件是 package.json。该文件定义了项目的元数据、依赖关系、脚本命令等。

以下是一些重要的配置项：

{
  "name": "obsidian-math-plus",
  "version": "1.0.0",
  "description": "A plugin for Obsidian to enhance math support.",
  "main": "dist/main.js",
  "scripts": {
    "build": "tsc",
    "watch": "tsc -w"
  },
  "dependencies": {
    "obsidian": "^0.12.0"
  },
  "devDependencies": {
    "@types/obsidian": "^0.12.0",
    "typescript": "^4.0.0"
  }
}

• name 和 version: 定义了项目的名称和版本号。
• description: 提供了项目的简短描述。
• main: 指定了打包后 JavaScript 文件的入口。
• scripts: 定义了可运行的脚本命令，如 build 用于构建项目，watch 用于监视文件变化并重新构建。
• dependencies: 列出了项目运行时依赖的包。
• devDependencies: 列出了项目开发时依赖的包。

通过 npm 或 yarn 运行 build 脚本，可以编译 TypeScript 代码为 JavaScript 代码，以便在 Obsidian 中使用。