Obsidian LanguageTool 插件技术文档

Obsidian LanguageTool 插件技术文档

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

安装指南

自动安装

1. 打开 Obsidian 应用，进入设置页面。
2. 在“社区插件”选项中，关闭“安全模式”。
3. 点击“浏览”按钮，搜索“LanguageTool Integration”。
4. 找到插件后，点击“安装”按钮。
5. 安装完成后，点击“启用”按钮以激活插件。

手动安装

1. 从最新发布版本中下载 main.js、styles.css 和 manifest.json 文件。
2. 将这些文件复制到你的 Obsidian 库目录下的 .obsidian/plugins/obsidian-languagetool-plugin/ 文件夹中。

项目的使用说明

设置与使用

1. 安装并启用插件后，你可以设置三个快捷键（在“设置”/“快捷键”中），这些快捷键可以在“LanguageTool Integration”描述下找到。
2. 确保这些快捷键与 Obsidian 内置的拼写检查功能没有冲突。

功能说明

• 检查文本：检查整个文档，如果没有选择文本，则检查整个文档。如果只想检查某个单词、句子或段落，选择相应文本后按下快捷键。点击 LanguageTool 标记为可能拼写错误的红色下划线单词，会弹出更正建议窗口，并可以选择将单词添加到个人词典。
• 清除建议：清除文档或选定文本中的所有红色下划线，这些下划线表示未更正或未更改的单词或段落。
• 切换自动检查：切换自动拼写检查功能的开关，可以在写作或修改文档内容时自动进行拼写检查。

语言选择

LanguageTool 会自动检测使用的语言，通常不需要手动选择特定语言。此功能允许用户在同一文档中使用不同语言进行拼写检查（例如，用英语写的论文中包含外语引文），这是 Obsidian 内置拼写检查功能通常无法实现的。

项目API使用文档

支持 LanguageTool 高级账户

1. 要使用高级功能，你需要一个 LanguageTool 高级账户和一个 API 密钥。
2. 你可以在 LanguageTool 网站 生成你的 API 密钥。
3. 在插件设置中配置你的电子邮件、API 密钥和新 URL（https://api.languagetoolplus.com）。

报告问题

请将任何与插件相关的错误、问题或建议直接报告到此 GitHub 仓库，而不是 LanguageTool 支持团队，因为这是一个非官方的社区插件。

项目安装方式

自动安装

1. 打开 Obsidian 应用，进入设置页面。
2. 在“社区插件”选项中，关闭“安全模式”。
3. 点击“浏览”按钮，搜索“LanguageTool Integration”。
4. 找到插件后，点击“安装”按钮。
5. 安装完成后，点击“启用”按钮以激活插件。

手动安装

1. 从最新发布版本中下载 main.js、styles.css 和 manifest.json 文件。
2. 将这些文件复制到你的 Obsidian 库目录下的 .obsidian/plugins/obsidian-languagetool-plugin/ 文件夹中。

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