Git Product home page Git Product logo

obsidian-antidote's Introduction

Antidote Grammar Checker Integration

This Obsidian plugin is an unofficial integration of Antidote, a powerful grammar checker.

Antidote supports these languages:

  • English
  • French

This plugin works with Antidote 10 (using Connectix version 11 or higher) and higher, and Antidote web, on macOS (11 and higher), Linux and Windows.

This plugin does not work on smartphones.

How to install

From Obsidian

This plugin can be found in Obsidian's community plugins library, Settings > Community Plugins > Browse: antidote-grammar-checker-integration

Manual installation

Download main.js, manifest.json, styles.css from the latest release and put them into <vault>/.obsidian/plugins/antidote-grammar-checker-integration folder.

How to use

This plugin adds 4 icons into the status bar:

  • The check within a circle corresponding to the Antidote corrector, that will check the whole document
  • The check corresponding to the Antidote corrector
  • The green book corresponding to the Antidote dictionary
  • The orange book corresponding to the Antidote guide

You can show or hide every icon from settings.

It also adds command for corrector, dictionary and guide.

Behavior of "Correct All" and "Corrector"

The "Correct All" send the whole document to Antidote, or, the selection, whereas the "simple correct" send the text depending the position of the cursor and the selection. The "simple correct" has the same behavior as the official integrations in other software (VS Code, Word, etc.).

Additional note for Linux users

Antidote 10 is the latest supported version of Antidote on this OS. Accordingly, the Connectix version 10 installed with this version is not supported.

In order to use Antidote 10 (or web) with this plugin, you will have to install the latest version of Connectix (version 11 or higher). Connectix is the bridge between Obsidian and Antidote (10, 11+, web), so by keeping Antidote 10 with Connectix 11, you will be able to use this plugin.

You can download Connectix 11 from your Client Portal, under the "Useful links" section: "Connectix Utility for Antidote Web"

Support this plugin

Donate with PayPal

Buy Me A Coffee

obsidian-antidote's People

Contributors

acibi avatar heziode avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

obsidian-antidote's Issues

Allow option to disable spellcheck icon

Add plugin settings boolean toggle option to disable the spellcheck green button from bottom right corner.

Once a keyboard command is implemented (as per #1), the spellcheck icon becomes optional. The space used by the icon is important to users with a rich interface and a large number of plugins installed.

Does not work with the new version of Obsidian

  • I'm submitting a ...
    [X] bug report
    [ ] feature request
    [ ] question about the decisions made in the repository
    [ ] question about how to use this project

  • Summary
    Fantastic plug-in. I'm using the 2.1.1 version on Mac (macOS Monterey Version 12.6.1), and unfortunately since the new version of Obsidian (1.3.0 - Installer 1.2.8), it does not work anymore.

Antidote version : Antidote bilingue v4.0.1 (Français 11.4.5767 | Anglais 11.4.5767)
macOS version : Monterey Version 12.6.1
Obsidian version : 1.3.0 - Installer 1.2.8
Plugin version : 2.1.1

Inconsistent results for Fountain syntax

I have a .md file which is written in fountain syntax, please see below:
https://github.com/Darakah/obsidian-fountain

The script is a bit over 3600 characters.

When clicking the button to start Antidote for correction, the results are very inconsistent, depending of where I click in the fountain script, I can anything from a few words to several lines of text in Antidote. Never the whole text.

Antidote (Connectix) open API does not support Markdown formatting

  • I'm submitting a ...
    [X] bug report

  • Summary

Before using the open API of Connectix, this project uses the old private API. The private API supported markdown formatting into Antidote.

Currently, with the open API, it seems not working.

Does the open API support it? If yes, how can we support it?

Ping @Acibi @alaroucheDruide

Here is a diff:

With (old) private API

With (old) private API

With open API

With open API

Add keyboard command to Ctrl+P command Palette

Add option to Ctrl+P command palette with a function similar to clicking the spellcheck button. Allow the plugin settings to configure a keyboard shortcut for the newly added command.

This will allow users to open Antidote spellcheck from keyboard instead of using a mouse action.

How to install Connectix 11 on MacOs when Antidote 10 ii already installed ?

  • I'm submitting a ...
    [ ] bug report
    [ ] feature request
    [ ] question about the decisions made in the repository
    [ x] question about how to use this project

I have downloaded the Connectix_11.5.0.1_45_Mac.dmg from the official site, and when I start the installation it complains because antidote 10 is already installed.

If I uninstall Antidote 10 of course I can install it, but then when I install back the the install 10 the Connectix 10 is installed

If I start manually the Connectix 11 it does not access the local Antidote 10, and it propose to access the web version that is no more available.

Plugin settings missing

Plugin settings seems to have gone completely.

Unfortunately this becomes a serious issue for me, as this plugin has 4 icons and is using 3cm+ of screen space.

As an user, I want the option to disable individual icons from being displayed, and have the option to set shortcuts where applicable.

No documentation in README.md for full document correction

I noticed there is no documentation for the newly added feature to check an entire document instead of using the cursor to send text to Antidote.

It would be worth updating the screenshot and adding a few words around the feature, especially for new users.

Antidote 10 support

I tested the plugin with both Antidote version 10 and version 11 and it currently works only with version 11.

Please note, the integration of "other" applications works with Antidote 10.

Either:

  1. Change README.md and clarify that this plugin works only with Antidote 11.
  2. Fix the plugin so that it works with Antidote version 10, too.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.