Obsidian 编辑工具栏插件安装与使用教程
1. 目录结构及介绍
在 obsidian-editing-toolbar
的仓库中,你可以看到以下主要的文件和目录:
.
├── README.md // 主要的项目说明文件
├── build // 构建后的资源文件
│ └── ... // 包含生成的插件代码
├── src // 源代码目录
│ ├── cmenu.ts // 部分功能实现
│ ├── index.ts // 入口文件
│ ├── ... // 其他源代码文件
├── .gitignore // Git 忽略文件列表
├── LICENSE // 许可证文件
├── README-zh_cn.md // 中文版项目说明文件
├── editing-toolbar-demo.gif // 功能演示动图
├── manifest.json // 插件元数据文件
├── package.json // 项目依赖和配置文件
├── rollup.config.js // 构建工具配置文件
└── tsconfig.json // TypeScript 配置文件
└── versions.json // 版本信息文件
2. 启动文件介绍
index.ts
这是插件的主要入口文件,它包含了初始化逻辑、事件监听器和其他关键组件的定义。大部分插件的核心功能和自定义命令都在这个文件中定义。
manifest.json
这个文件是 Obsidian 插件的元数据描述文件,包含了插件名称、版本、作者、依赖和提供的功能等信息。当你安装或更新插件时,Obsidian 将读取该文件来识别和处理插件。
3. 配置文件介绍
package.json
这是 Node.js 项目的标准配置文件,列出了所有依赖库以及项目的基本信息(如 name, version)。同时,它还包含了 npm 脚本,用于执行构建、测试等操作。
tsconfig.json
TypeScript 的配置文件,定义了编译选项和规则,比如目标语言版本、严格性检查等。这影响到 TypeScript 代码如何被编译成 JavaScript。
.gitignore
Git 忽略文件列表,指定哪些文件不需要被 Git 管理和版本控制。例如,构建产出的文件通常会被忽略。
要安装和使用 obsidian-editing-toolbar
插件,你需要遵循 Obsidian 插件管理器的指示。通常,你可以在 Obsidian 应用内找到插件商店并搜索该插件,或者通过手动将插件文件夹放入 ~/.obsidian/plugins/
目录来手动安装。激活插件后,在 Obsidian 中即可看到新增的编辑工具栏。
如果你想要对插件进行自定义或开发,可以克隆该项目,然后使用 npm install
安装依赖并运行 npm run build
来构建本地版本。最后,将构建结果复制到你的 Obsidian 插件目录进行测试。