Obsidian-Matter 插件配置与启动教程

1. 项目目录结构及介绍

Obsidian-Matter 插件项目的目录结构如下：

• .github/: 存放 GitHub 工作流文件，用于自动化处理如代码审查、发布等操作。
• docs/: 存放项目文档。
• src/: 包含项目的源代码。
• .editorconfig: 编辑器配置文件，用于统一不同开发者的代码风格。
• .eslintrc: ESLint 配置文件，用于代码质量检查。
• .gitignore: Git 忽略文件列表，指定 Git 应该忽略的文件和目录。
• .nvmrc: 指定项目的 Node.js 版本。
• LICENSE: 项目许可证文件，本项目采用 GPL-3.0 许可。
• README.md: 项目自述文件，介绍了项目的相关信息和使用方法。
• esbuild.config.mjs: esbuild 配置文件，用于构建项目。
• manifest.json: 插件元数据文件，定义了插件的名称、版本等信息。
• package.json: 项目包配置文件，定义了项目的依赖和脚本。
• styles.css: 项目样式文件。
• tsconfig.json: TypeScript 配置文件。
• types.d.ts: TypeScript 类型定义文件。
• versions.json: 存储版本信息的文件。
• yarn.lock: 项目依赖锁文件，记录了项目依赖的精确版本。

2. 项目的启动文件介绍

在 src/ 目录下包含了插件的主体代码。项目的入口文件通常是 index.ts 或 main.ts。以下是启动文件的基本内容：

// index.ts

// 引入必要的库和模块
import { Plugin } from 'obsidian';

// 定义插件类
export default class MatterPlugin extends Plugin {
  async onload() {
    // 插件加载时执行的代码
  }

  async onunload() {
    // 插件卸载时执行的代码
  }
}

// 在插件市场中注册插件
export function registerPlugin(app: App) {
  app.addPlugin(new MatterPlugin());
}

3. 项目的配置文件介绍

配置文件主要用于定义插件的行为和外观。本项目中的主要配置文件包括：

• manifest.json: 插件的元数据文件，例如：

{
  "id": "obsidian-matter",
  "name": "Matter Obsidian Plugin",
  "version": "1.1.4",
  "description": "Sync all of your Matter highlights and notes directly to your Obsidian vault.",
  "author": "getmatterapp",
  "icon": "icon.png",
  "svg": "icon.svg",
  "license": "GPL-3.0",
  "minAppVersion": "0.13.0"
}

• package.json: 定义了项目的依赖和脚本，例如：

{
  "name": "obsidian-matter",
  "version": "1.1.4",
  "description": "A plugin to sync Matter highlights and notes with Obsidian.",
  "main": "index.js",
  "scripts": {
    "build": "esbuild build --bundle --minify --platform=node --external-table './**/*' --entry-point './src/index.ts' -- outfile './dist/index.js'"
  },
  "keywords": [
    "obsidian",
    "matter"
  ],
  "dependencies": {
    "obsidian": "^0.13.0"
  },
  "devDependencies": {
    "esbuild": "^0.11.0",
    "typescript": "^4.0.0"
  }
}

这些配置文件定义了插件的基本信息和构建流程，确保了插件能够正确地加载和运行。