Obsidian Excalidraw 中文插件启动与配置教程

1. 项目目录结构及介绍

obsidian-excalidraw-cn-plugin/
├── .gitignore             # 忽略文件列表
├── package-lock.json      # 依赖项锁文件
├── package.json           # 项目配置文件
├── plugin.json            # 插件配置文件
├── README.md              # 项目说明文件
├── src/
│   ├── index.ts           # 插件入口文件
│   ├── manifest.json      # 插件元数据文件
│   ├── styles/
│   │   └── main.less      # 插件样式文件
│   └── utils/             # 工具函数目录
│       └── index.ts       # 工具函数文件
└── tsconfig.json          # TypeScript 配置文件

• .gitignore：指定Git应该忽略的文件和目录，以避免将不必要或敏感的文件提交到版本控制系统中。
• package-lock.json：记录项目的依赖项及其精确版本，以确保在不同环境中安装时能够保持一致。
• package.json：定义项目的依赖、脚本和元数据。
• plugin.json：定义Obsidian插件的配置信息，如插件名称、描述、版本等。
• README.md：提供项目的详细说明、安装步骤和使用指南。
• src：源代码目录，包含插件的主要逻辑和资源。
  • index.ts：插件的入口文件，负责初始化插件。
  • manifest.json：插件的元数据文件，定义插件的名称、描述、版本等信息。
  • styles：样式目录，包含插件所需的CSS样式。
    • main.less：主样式文件。
  • utils：工具函数目录，存放一些通用的工具函数。

2. 项目的启动文件介绍

项目的启动文件为src/index.ts。该文件负责初始化插件，并注册插件所需的功能和事件监听器。以下是启动文件的基本结构：

import { Plugin } from 'obsidian';

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

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

在onload方法中，可以添加初始化插件时需要执行的代码，如注册命令、添加自定义视图等。onunload方法用于在插件卸载时执行清理操作，如移除事件监听器、清除自定义视图等。

3. 项目的配置文件介绍

项目的配置文件为plugin.json。该文件定义了插件的基本信息和配置选项。以下是配置文件的基本结构：

{
  "id": "obsidian-excalidraw-cn-plugin",
  "name": "Obsidian Excalidraw 中文插件",
  "description": "为Obsidian添加Excalidraw功能的中文插件",
  "version": "1.0.0",
  "author": "korbinzhao",
  "minAppVersion": "0.13.0",
  "main": "src/index.ts",
  "icon": "excalidraw.png",
  "bugs": {
    "url": "https://github.com/korbinzhao/obsidian-excalidraw-cn-plugin/issues"
  },
  "license": "MIT",
  "contributes": {
    "commands": [
      {
        "id": "excalidraw:toggle",
        "name": "Toggle Excalidraw"
      }
    ]
  }
}

在plugin.json中，可以定义插件的ID、名称、描述、版本、作者、最小应用版本、主文件路径、图标、问题反馈链接、许可证信息以及贡献的部分，如命令、菜单项等。在本例中，插件定义了一个命令excalidraw:toggle，用于切换Excalidraw视图。