Add Grammarly spellchecking to Obsidian.md.

Related tags

Learning resource obsidian-grammarly-plugin
Overview

Obsidian Grammarly Plugin

This is a plugin for Obsidian which adds Grammarly support directly in your editor.

Demo

NOTE: This plugin is a work in progress. It will be submitted to "Community Plugins" at a later time.

Installation

Quick starting guide for installing the plugin:

  • Download obsidian-grammarly-plugin.zip from the latest release.
  • Extract the file in a .obsidian/plugins folder in your Vault (.obsidian is probably hidden)
  • Open Obsidian, go to "Community Plugins" and enable "Grammarly Plugin".

Usage

There are two ways to use this plugin.

  1. Click on the Grammarly logo in the left ribbon.
  2. Open the command palette and run the "Enable Grammarly" command.

Grammarly will now be enabled for the remainder of the session. At the moment you (generally) have to quit Obsidian to get rid of it.

About

This plugin is pretty simple. It includes the Grammarly Editor SDK so that you get a Grammarly button in the lower left corner of your editor window. You also get underlines and the typical in-place substitutions that Grammarly provides.

Roadmap

Obsidian Grammarly Plugin is far from done. This is more of a proof-of-concept version at this stage. Here are the planned features before submission to "Community Plugins" will be made.

1.0.0

  • Support for logging in to your own Grammarly account (for premium features)
  • Style customizations
  • Custom settings
  • Ability to disable Grammarly
  • Hide/move "Grammarly-powered editor" tooltip
  • Test on Windows
  • Test on iOS
  • Test on Android
Comments
  • Why hide/move

    Why hide/move "Grammarly-powered editor" tooltip?

    We use aria-label for screen readers to convey that user is in an Grammarly-powered editor. If it's causing any issue, please create an issue in the http://github.com/grammarly/grammarly-for-developers repository.

    question 
    opened by znck 7
  • The plugin is not loading

    The plugin is not loading

    After following the quick start guide for installing the plugin and trying to enable it, I get a popup modal in the upper right-hand side saying, "Failed to load plugin obsidian-grammarly-plugin"

    The steps I followed are:

    1. Download obsidian-grammarly-plugin.zip from the latest release.
    2. Extract the file in a .obsidian/plugins folder in your Vault (.obsidian is probably hidden)
    3. Open Obsidian, go to "Community Plugins" and enable "Grammarly Plugin".

    Obsidian_OQyc1pJyAH

    opened by harmindersinghnijjar 7
  • Incorrect placement of Grammarly popover

    Incorrect placement of Grammarly popover

    Hi! For me the error window is always being displayed further to the right compared to where the error actually is in the text.

    Example: image

    I am running Obsidian 1.0.3.

    enhancement 
    opened by SebbeJohansson 6
  • Receive

    Receive "Failed to load plugin obsidian-grammarly-plugin" when enabling plugin on Windows 11

    Receive "Failed to load plugin obsidian-grammarly-plugin" when enabling plugin under Community Plugins

    Tried again after disabling all addons and theme changes and used current and previous releases of plugin with same result

    Thanks

    opened by ContrarianIRL 2
  • Grammerly button disappears if you close a tab

    Grammerly button disappears if you close a tab

    Obsidian v1.0.0

    Repro steps:

    • Enable the plugin, Grammerly button should show up in the bottom left.
    • Close a tab
    • Open a new document
    • Grammerly button doesn't show up.
    opened by patleeman 2
  • Update README.md for TS compilation

    Update README.md for TS compilation

    Add steps to the readme for compilation from TS to JS:

    ## Installation

A quick starting guide for installing the plugin:

-   Download obsidian-grammarly-plugin.zip from the latest release.
    -   Go to: https://github.com/simonpacis/obsidian-grammarly-plugin/releases.
    -   Go to the latest release, click "Assets" and download the zip file from here.
-   Extract the file in a .obsidian/plugins folder in your Vault (.obsidian is probably hidden).
-   Run `npm i` to install dependencies.
-   Run `npm run build` to compile the plugin.
-   Open Obsidian, go to "Community Plugins" and enable "Grammarly Plugin".
    opened by sebapoole 1
  • How can I help to develop the login feature?

    How can I help to develop the login feature?

    I've read https://developer.grammarly.com/docs/connected-accounts#configuring-connected-accounts-for-desktop-clients-electron and I'm trying to figure out where to start to be able to code the "login" feature.

    Do you have any idea @simonpacis how to start with that?

    opened by jjanvier 2
  • Suggestions as a beta user

    Suggestions as a beta user

    Hi,

    First of all, thank you guys for developing this plugin.

    I have some suggestions for a better experience.

    1. It would be nice if we can enable Grammarly permanently in the settings.
    2. It would be nice if we have a choice of the location of the Grammarly button. Currently, it's on the left, but I'm used to seeing it on the right, and there may be more people like me.

    Best, Youngin Kim

    opened by yiwkd2 2
  • The pop-up disappears too quickly

    The pop-up disappears too quickly

    Sometimes, when the pop-up appears far from the text to be corrected, it can disappear before the pointer can get there. This happens, for example, in the Obsidian Nord theme.

    A solution could be having a setting to make the pop-up permanent until closed by clicking or by approving/declining the suggestion.

    opened by moriakaice 1
  • Embedded PDF's break Grammarly

    Embedded PDF's break Grammarly

    Hi, I have installed and enabled the plugin. But none of the errors is being highlighted.

    image

    Here is the console output:

    'Uncaught TypeError: Cannot read properties of undefined (reading 'grammarlySkip')
    at Yr ([email protected]?clientId=client_SZRuwBMe5opCznxqMQCG3q&packageName=%40grammarly%2Feditor-sdk:17:94237)
    at pd._hTb ([email protected]?clientId=client_SZRuwBMe5opCznxqMQCG3q&packageName=%40grammarly%2Feditor-sdk:17:396297)
    at [email protected]?clientId=client_SZRuwBMe5opCznxqMQCG3q&packageName=%40grammarly%2Feditor-sdk:17:397345
    at NodeList.forEach (<anonymous>)
    at pd._hTb ([email protected]?clientId=client_SZRuwBMe5opCznxqMQCG3q&packageName=%40grammarly%2Feditor-sdk:17:397308)
    at [email protected]?clientId=client_SZRuwBMe5opCznxqMQCG3q&packageName=%40grammarly%2Feditor-sdk:17:397345
    at NodeList.forEach (<anonymous>)
    at pd._hTb ([email protected]?clientId=client_SZRuwBMe5opCznxqMQCG3q&packageName=%40grammarly%2Feditor-sdk:17:397308)
    at [email protected]?clientId=client_SZRuwBMe5opCznxqMQCG3q&packageName=%40grammarly%2Feditor-sdk:17:397345
    at NodeList.forEach (<anonymous>)
Yr @ [email protected]?clientId=client_SZRuwBMe5opCznxqMQCG3q&packageName=%40grammarly%2Feditor-sdk:17
_hTb @ [email protected]?clientId=client_SZRuwBMe5opCznxqMQCG3q&packageName=%40grammarly%2Feditor-sdk:17
(anonymous) @ [email protected]?clientId=client_SZRuwBMe5opCznxqMQCG3q&packageName=%40grammarly%2Feditor-sdk:17
_hTb @ [email protected]?clientId=client_SZRuwBMe5opCznxqMQCG3q&packageName=%40grammarly%2Feditor-sdk:17
(anonymous) @ [email protected]?clientId=client_SZRuwBMe5opCznxqMQCG3q&packageName=%40grammarly%2Feditor-sdk:17
_hTb @ [email protected]?clientId=client_SZRuwBMe5opCznxqMQCG3q&packageName=%40grammarly%2Feditor-sdk:17
(anonymous) @ [email protected]?clientId=client_SZRuwBMe5opCznxqMQCG3q&packageName=%40grammarly%2Feditor-sdk:17
_hTb @ [email protected]?clientId=client_SZRuwBMe5opCznxqMQCG3q&packageName=%40grammarly%2Feditor-sdk:17
(anonymous) @ [email protected]?clientId=client_SZRuwBMe5opCznxqMQCG3q&packageName=%40grammarly%2Feditor-sdk:17
_hTb @ [email protected]?clientId=client_SZRuwBMe5opCznxqMQCG3q&packageName=%40grammarly%2Feditor-sdk:17
(anonymous) @ [email protected]?clientId=client_SZRuwBMe5opCznxqMQCG3q&packageName=%40grammarly%2Feditor-sdk:17
_hTb @ [email protected]?clientId=client_SZRuwBMe5opCznxqMQCG3q&packageName=%40grammarly%2Feditor-sdk:17
encode @ [email protected]?clientId=client_SZRuwBMe5opCznxqMQCG3q&packageName=%40grammarly%2Feditor-sdk:17
(anonymous) @ [email protected]?clientId=client_SZRuwBMe5opCznxqMQCG3q&packageName=%40grammarly%2Feditor-sdk:17
Gt @ [email protected]?clientId=client_SZRuwBMe5opCznxqMQCG3q&packageName=%40grammarly%2Feditor-sdk:17
updateText @ [email protected]?clientId=client_SZRuwBMe5opCznxqMQCG3q&packageName=%40grammarly%2Feditor-sdk:17
(anonymous) @ [email protected]?clientId=client_SZRuwBMe5opCznxqMQCG3q&packageName=%40grammarly%2Feditor-sdk:17
    bug 
    opened by rupeshknn 3
Releases(Pre-release)
Owner
Simon Klit Pacis
There is nothing better for a person than that he should eat and drink and find enjoyment in his toil.
Simon Klit Pacis
GitHub
Auto-Fix Hundreds of Grammarly Errors With This Script

This script automatically applies your Grammarly suggestions. Use case: Large document with 100+ errors How to use: Go to Grammarly Web app Go to Edit

null 48 Jan 3, 2023
A plugin for Obsidian (https://obsidian.md) that adds a button to its search view for copying the Obsidian search URL.

Copy Search URL This plugin adds a button to Obsidian's search view. Clicking it will copy the Obsidian URL for the current search to the clipboard. T

Carlo Zottmann 6 Dec 26, 2022
An Obsidian plugin to paste Excel tables as Markdown tables in Obsidian editor.

Obsidian Excel to Markdown Table An Obsidian plugin to paste Excel tables as Markdown tables in Obsidian editor. Demo You can paste the copied Excel d

Ganessh Kumar 108 Jan 4, 2023
Obsidian-dataview-table-filter-menu - Dynamically created filter menu for dataview tables in obsidian

Dataview table Filter Menu for Obsidian Dynamically created filter menu for data

shiro 17 Sep 24, 2022
Obsidian-Snippet-collection - A collection of snippet to customize obsidian

This repo is a collection of CSS snippets for Obsidian.md. To install them on PC

Mara 110 Dec 22, 2022
Obsidian Web: Connect your browser with your Obsidian notes

Obsidian Web: Connect your browser with your Obsidian notes This is an unofficial Chrome extension for Obsidian that lets you send content from the we

Adam Coddington 97 Jan 3, 2023
This is a plugin for Obsidian (https://obsidian.md). Can open document with `.html` and `.htm` file extensions.

Obsidian HTML reader Plugin This is a plugin for Obsidian (https://obsidian.md). Can open document with .html and .htm file extensions. Obsidian HTML

null 37 Dec 27, 2022
An Obsidian plugin that lets you browse the web within Obsidian.

Obsidian Web Browser An Obsidian plugin that allows you to browse the web within Obsidian using v1.0 tabs. The core functionality of the plugin, rende

Dion Tryban 102 Dec 28, 2022
A Zotero add-on that scans your Markdown reading notes, tags the associated Zotero items, and lets you open notes for the Zotero items in Obsidian.

Zotero Obsidian Citations Adds colored tags to Zotero items that have associated Markdown notes stored in an external folder. Open an associated Markd

Dae 210 Jan 4, 2023
An Obsidian plugin to add (prepend or append) specified content to a note (existing or new) without opening another pane.

Obsidian Note Content Pusher An Obsidian plugin to add (prepend or append) specified content to a note (existing or new) without opening another pane.

Henry Gustafson 21 Nov 6, 2022
Obsidian plugin: Implicitly add an alias matching the first heading in a document.

Alias from heading Aliases in Obsidian make it convenient to provide display names to document links. However, there are a few pain points: Aliases ar

Chris Basham 6 Dec 17, 2022
BestBuy Bot is an Add to cart and Auto Checkout Bot. This auto buying bot can search the item repeatedly on the ITEM page using one keyword. Once the desired item is available it can add to cart and checkout very fast. This auto purchasing BestBuy Bot can work on Firefox Browser so it can run in all Operating Systems. It can run for multiple items simultaneously.

BestBuy Bot — Open Source GPU/PS5/Xbox Bot I took bits from best open and closed sourced bots and made this simple bot. Please star my repo if this co

Karan Kapuria 585 Dec 31, 2022
Here I will add daily one problem with solution basic to advance level and try to add multiple solutions of a single problem.

#100-code-days ?? I am adding daily 1 JavaScript solution here ?? and you can fork the repo for add your solution for any specific probelm ⌛️ Day 01:

Amir Sohel 4 Jan 22, 2022
Lets you add a character to Hacker News links to add social media and OpenGraph previews for sharing on things like Slack or Twitter.

news.ycombinator1.com Lets you add a character to Hacker News links to add social media and OpenGraph previews for sharing on things like Slack or Dis

Ian Langworth ☠ 38 Sep 18, 2022
This is college project in which me and my team create a website that provide the tools for basic text modification and add todos also we add blog init.

Getting Started with Create React App This project was bootstrapped with Create React App. Available Scripts In the project directory, you can run: np

Ayush 4 Jun 9, 2022
This project will be a basic website that allows users to add/remove books from a list. The main objective is to understand how to use JavaScript objects and arrays and dynamically modify the DOM and add basic events.

Awesome-books Awesome Books This project will be a basic website that allows users to add/remove books from a list. This project is part of the Microv

Aleksandra Ujvari 10 Oct 3, 2022
Awesome Books is a basic website that allows users to add/remove books from a list (including the title and author). It has threee different sections: 1. books list, 2. add new book, 3. contact.

awesomeBooks-modules Awesome Books is a basic website that allows users to add/remove books from a list (including the title and author). It has three

Juan Diaz 6 Aug 26, 2022
In this project, I built a basic website that allows users to add/remove books from a list using HTML/CSS to build the app and JavaScript to add functionalities. This project was organized using modules and ES6 syntax implemented.

Awesome books: with ES6 Description the project. Built With HTML CSS JAVASCRIPT Live Demo (if available) Live Demo Link Getting Started This is an exa

Emem Ekpo 7 Sep 9, 2022
A knowledge management garden for https://obsidian.md, in which to grow your ideas

?? ?? The Obsidian Garden Welcome to your Knowledge Garden The Obsidian Garden is both guide in helping you create your own knowledge system, and a kn

Tane Piper 145 Dec 27, 2022