Obsidian LanguageTool 插件使用教程

Obsidian LanguageTool 插件使用教程

obsidian-languagetool-pluginlanguagetool plugin for obsidian项目地址:https://gitcode.com/gh_mirrors/ob/obsidian-languagetool-plugin

项目目录结构及介绍

Obsidian LanguageTool 插件的目录结构如下：

obsidian-languagetool-plugin/
├── .github/
│   └── workflows/
│       └── main.yml
├── .obsidian/
│   └── plugins/
│       └── obsidian-languagetool-plugin/
├── assets/
│   ├── icon.png
│   └── styles.css
├── src/
│   ├── main.ts
│   ├── styles.ts
│   └── settings.ts
├── .gitignore
├── .npmrc
├── .prettierrc
├── LICENSE
├── README.md
├── package.json
├── tsconfig.json
└── yarn.lock

目录结构说明

• .github/workflows/main.yml: GitHub Actions 的工作流配置文件，用于自动化构建和发布。
• .obsidian/plugins/obsidian-languagetool-plugin/: Obsidian 插件的配置目录。
• assets/: 包含插件的图标和样式文件。
• src/: 插件的主要源代码目录，包含 TypeScript 文件。
• .gitignore: Git 忽略文件配置。
• .npmrc: npm 配置文件。
• .prettierrc: Prettier 代码格式化配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• package.json: npm 包配置文件，包含依赖和脚本。
• tsconfig.json: TypeScript 编译配置文件。
• yarn.lock: Yarn 包管理器生成的锁定文件。

项目的启动文件介绍

项目的启动文件位于 src/main.ts。这个文件是插件的入口点，负责初始化插件并注册必要的 Obsidian 事件监听器。

src/main.ts 主要功能

• 导入必要的模块和依赖。
• 定义插件类并继承 Obsidian 的 Plugin 类。
• 在插件类中定义 onload 和 onunload 方法，分别在插件加载和卸载时执行。
• 注册命令和设置页面。

项目的配置文件介绍

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

package.json

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

{
  "name": "obsidian-languagetool-plugin",
  "version": "1.0.0",
  "description": "LanguageTool integration for Obsidian.",
  "main": "main.js",
  "scripts": {
    "dev": "rollup --config rollup.config.js -w",
    "build": "rollup --config rollup.config.js"
  },
  "keywords": [],
  "author": "Clemens-E",
  "license": "MIT",
  "devDependencies": {
    "@rollup/plugin-commonjs": "^15.0.0",
    "@rollup/plugin-node-resolve": "^9.0.0",
    "@rollup/plugin-typescript": "^6.0.0",
    "@types/node": "^14.0.0",
    "obsidian": "^0.9.10",
    "rollup": "^2.3.4",
    "tslib": "^2.0.0",
    "typescript": "^4.0.0"
  }
}

tsconfig.json

tsconfig.json 文件是 TypeScript 的编译配置文件，定义了 TypeScript 编译器的选项。

{
  "compilerOptions": {
    "module": "ESNext",
    "target": "ESNext",
    "moduleResolution": "node",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "outDir": "dist",
    "rootDir": "src"
  },
  "include": ["src/**/*"]
}

以上是 Obsidian LanguageTool 插件的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望

obsidian-languagetool-pluginlanguagetool plugin for obsidian项目地址:https://gitcode.com/gh_mirrors/ob/obsidian-languagetool-plugin