Obsidian Grammarly 插件使用教程
1. 项目的目录结构及介绍
Obsidian Grammarly 插件的目录结构如下:
obsidian-grammarly-plugin/
├── .github/
│ └── workflows/
│ └── main.yml
├── .obsidian/
│ └── plugins/
│ └── obsidian-grammarly-plugin/
│ ├── main.js
│ ├── manifest.json
│ └── styles.css
├── .gitignore
├── LICENSE
├── README.md
├── package.json
└── src/
├── main.ts
├── styles.ts
└── utils.ts
目录结构介绍
.github/workflows/main.yml
: GitHub Actions 的工作流配置文件,用于自动化构建和发布。.obsidian/plugins/obsidian-grammarly-plugin/
: Obsidian 插件的安装目录,包含插件的主要文件。main.js
: 插件的主入口文件。manifest.json
: 插件的元数据文件,包含插件的名称、版本等信息。styles.css
: 插件的样式文件。
.gitignore
: Git 忽略文件列表。LICENSE
: 项目的开源许可证。README.md
: 项目的说明文档。package.json
: Node.js 项目的配置文件,包含依赖项和脚本。src/
: 插件的源代码目录。main.ts
: 插件的主 TypeScript 文件。styles.ts
: 插件的样式 TypeScript 文件。utils.ts
: 插件的工具函数文件。
2. 项目的启动文件介绍
项目的启动文件是 src/main.ts
,它是插件的主入口点。该文件负责初始化插件并注册必要的 Obsidian 事件监听器。
src/main.ts
主要功能
- 导入必要的模块和依赖项。
- 定义插件的初始化逻辑。
- 注册 Obsidian 事件监听器,以便在用户编辑文档时进行语法检查。
3. 项目的配置文件介绍
项目的配置文件是 manifest.json
,它位于 .obsidian/plugins/obsidian-grammarly-plugin/
目录下。该文件包含了插件的元数据和配置信息。
manifest.json
主要内容
id
: 插件的唯一标识符。name
: 插件的名称。version
: 插件的版本号。minAppVersion
: 插件支持的最低 Obsidian 版本。description
: 插件的描述信息。author
: 插件的作者信息。isDesktopOnly
: 是否仅支持桌面版 Obsidian。
通过这些配置信息,Obsidian 能够正确识别和加载插件。
以上是 Obsidian Grammarly 插件的基本使用教程,涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该插件。