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

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

2025-04-24 06:18:02作者:袁立春Spencer

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视图。

登录后查看全文
热门项目推荐

项目优选

收起
kernelkernel
deepin linux kernel
C
22
6
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
165
2.05 K
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
954
563
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
60
16
apintoapinto
基于golang开发的网关。具有各种插件,可以自行扩展,即插即用。此外,它可以快速帮助企业管理API服务,提高API服务的稳定性和安全性。
Go
22
0
giteagitea
喝着茶写代码!最易用的自托管一站式代码托管平台,包含Git托管,代码审查,团队协作,软件包和CI/CD。
Go
17
0
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
408
387
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Python
77
71
rainbondrainbond
无需学习 Kubernetes 的容器平台,在 Kubernetes 上构建、部署、组装和管理应用,无需 K8s 专业知识,全流程图形化管理
Go
14
1