Skip to content

tefkah/obsidian-write-good-plugin

 
 

Repository files navigation

Obsidian LanguageTool Plugin

This is a plugin for Obsidian.md that integrates LanguageTool.

Note: if you are worried about the privacy of your notes you should selfhost languagetool, whether it be locally on your pc or on a server Docker Image

If you decide to self host the service, you need to change the link in the configuration accordingly.

Installation

  1. In Obsidian, under Settings / Community plugins, disable "Safe mode" (read the safety warning).
  2. Click the Browse button for Community plugins.
  3. In the top-left search field, search for "LanguangeTool Integration". Click the Install button.
  4. After the installation is successful, click Enable to enable the plugin.

Setting Up & Use case

After installing and enabling the plugin, you can set up three hotkeys (under Settings / Hotkeys) which can be found under the description "LanguangeTool Integration" through the Filter search field, to find specific hotkey functions quicker. Make sure that there is no conflict with existing hotkeys and the spellcheck function within Obsidian, if enabled (Settings / Editor / Spellcheck ON/OFF).

  • "Check Text" checks the whole document in view, if no text is selected. If you want to check only a word, sentence or paragraph, select the text of choice and press the keyboard shortcut you have previously setup. Click on the red underlined word that LanguageTool identified as a possible spelling mistake to get corrective suggestions in a popover window, with the option to add the word to a personal dictionary.
  • "Clear Suggestions" clears the document or selected text of all red underlines from words or passages that were not corrected or changed.
  • "Toggle Automatic Checking" toggles ON/OFF the automatic spellchecking function as you write or change the document's contents.

LanguangeTool tries to auto-detect the language used. Selecting a specific language (under Settings / Plugin Options / LanguageTool Integration / Static language) is normally not necessary. This feature enables the user to spellcheck in different languages within the same document (e.g. a dissertation written in English with quotes in a foreign language), which is ordinarily not possible with the built-in spellcheck function of Obsidian.

Premium Accounts

We finally support LanguageTool Premium.

⚠️ Please report any bugs, issues or suggestions related to this Plugin to us (this GitHub Repository) directly, and not to the LanguageTool Support, as this is an unofficial community plugin

To use the premium features, you (obviously) need a Premium Account, and an API key. For you to receive an API Key, send a short notice to the LanguageTool support at [email protected], asking for it like "Please set an API key for my account, so I can use LanguageTool Premium with Obsidian."

Configure your email, API key, and the new URL (https://api.languagetoolplus.com) in the plugin settings

Manually installing the plugin

  • Copy over main.js, styles.css, manifest.json from the latest release to your vault VaultFolder/.obsidian/plugins/obsidian-languagetool-plugin/.

Demo

demo-02022022

About

✍️ Plugin for Obsidian to make you write-gooder

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 92.0%
  • CSS 5.5%
  • JavaScript 2.5%