-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add a contributing guide for grammalecte
- Loading branch information
1 parent
c02bdde
commit f331be0
Showing
2 changed files
with
33 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# Installing Grammalecte in Visual Studio | ||
|
||
## Motivation | ||
|
||
This project has a linter configured which can be run with `npm run lint`. This linter consists of a series of [Unified](https://unifiedjs.com/) plugins that spellcheck the French files, and it relies on a French dictionary. It essentially checks that the words exist, among other little things. It's not able to evaluate the grammar like an actual spellchecker. In other words, just because you run `npm run lint` doesn't mean your grammar and conjugation are correct. | ||
|
||
To answer this problem, the current recommendation is to add an actual spellcheck plugin to your code editor. If you use Visual Studio, then you can use Grammalecte. | ||
|
||
## Download Grammalecte | ||
|
||
Visit https://grammalecte.net/#download and select "CLI & Serveur". Once the zip file is downloaded, uncompress it and move it wherever you want on your system. Take good note of the path you choose, you'll need it to configure the plugin in the next step. | ||
|
||
## Add the plugin to Visual Studio | ||
|
||
Open Visual Studio and go to the "Extensions" panel. In the search bar, type in "grammalecte". You should find the plugin posted by jenselme. | ||
|
||
Install the plugin and read carefully the instructions. First, it requires Python3. Then it explains how to let Visual Studio know where to find the Grammalecte script. | ||
|
||
Access the plugin settings by clicking the cog icon next to the uninstall button. In the input "Path To Grammalecte Cli", indicate the path you choose for the Grammalecte folder and point to `grammalecte-cli.py`, as required by the installation instructions. Eventually, have a look at the other options to see what you wish to activate. | ||
|
||
By default, `.md` extension is already present in the list of extensions that Grammalecte can run, so you are good to go! If you have configured everything correctly, you should see Grammalecte underlying things in the documentation files. Don't consider every syntax detail, Grammalecte is not familiar with markdown specifics. Focus on French grammar and conjugation. |