Highlightr-Plugin 使用教程

1. 项目的目录结构及介绍

Highlightr-Plugin 是一个为 Obsidian 笔记应用设计的插件，提供了简单而美观的文本高亮功能。以下是该项目的目录结构及其介绍：

Highlightr-Plugin/
├── .github/
│   └── workflows/
├── assets/
│   └── icons/
├── src/
│   ├── main.ts
│   ├── styles.css
│   └── settings.ts
├── .gitignore
├── README.md
├── package.json
└── tsconfig.json

• .github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• assets/icons/: 存放插件使用的图标文件。
• src/: 插件的主要源代码目录。
  • main.ts: 插件的主入口文件。
  • styles.css: 插件的样式文件。
  • settings.ts: 插件的设置相关代码。
• .gitignore: Git 忽略文件配置。
• README.md: 项目说明文档。
• package.json: 项目的依赖和脚本配置。
• tsconfig.json: TypeScript 编译配置。

2. 项目的启动文件介绍

项目的启动文件是 src/main.ts。这个文件是插件的入口点，负责初始化插件并加载必要的资源。以下是 main.ts 的主要功能：

• 初始化插件实例。
• 注册插件的命令和事件监听器。
• 加载插件的样式文件。

3. 项目的配置文件介绍

项目的配置文件主要包括 package.json 和 tsconfig.json。

package.json

package.json 文件包含了项目的元数据和依赖信息，以及一些脚本命令。以下是一些关键字段：

• name: 插件的名称。
• version: 插件的版本号。
• description: 插件的描述。
• main: 插件的主入口文件路径。
• scripts: 包含一些常用的脚本命令，如 build 和 watch。
• dependencies: 插件运行所需的依赖包。
• devDependencies: 开发过程中所需的依赖包。

tsconfig.json

tsconfig.json 文件是 TypeScript 编译器的配置文件，定义了 TypeScript 项目的编译选项。以下是一些关键字段：

• compilerOptions: 包含编译选项，如 target、module、outDir 等。
• include: 指定需要编译的文件或目录。
• exclude: 指定不需要编译的文件或目录。

通过以上介绍，您可以更好地理解和使用 Highlightr-Plugin 插件。希望这份教程对您有所帮助！