|
2 | 2 |
|
3 | 3 | This extension brings [Grammarly](https://grammarly.com) to VS Code.
|
4 | 4 |
|
5 |
| - |
| 5 | +## Getting Started |
| 6 | + |
| 7 | +You need to configure which files should be checked with Grammarly. |
| 8 | + |
| 9 | +- Set `grammarly.files.include` or **Grammarly > Files > Include** to the allowed list of files. |
| 10 | +- Run `grammarly.check` or **Grammarly: Check text** command |
| 11 | + |
| 12 | +Default configuration: |
| 13 | + |
| 14 | +```json |
| 15 | +{ |
| 16 | + "grammarly.files.include": ["**/README.md", "**/readme.md", "**/*.txt"] |
| 17 | +} |
| 18 | +``` |
| 19 | + |
| 20 | +You may use `grammarly.files.exclude` to ignore specific files. |
| 21 | + |
| 22 | +## Grammarly account or premium |
| 23 | + |
| 24 | +Run `grammarly.login` or **Grammarly: Login / Connect your account** command to connect your Grammarly account. |
| 25 | +Run `grammarly.logout` or **Grammarly: Log out** to disconnect your account. |
| 26 | + |
| 27 | +## Configuration |
| 28 | + |
| 29 | +Configure dialect, document domain, and which check to include in settings. |
6 | 30 |
|
7 |
| -The status of the Grammarly text-checking session is displayed on the status bar (bottom right). |
| 31 | + |
| 32 | + |
| 33 | +## Supported Languages |
| 34 | + |
| 35 | +- plaintext |
| 36 | +- markdown (work in progress) — [CommonMark](https://commonmark.org/) |
| 37 | +- html (work in progress) |
| 38 | + |
| 39 | +## Troubleshooting |
| 40 | + |
| 41 | +The status of the Grammarly text-checking session is displayed on the status bar (bottom right). Clicking on the status bar icon would pause/resume text checking session. |
| 42 | + |
| 43 | + |
8 | 44 |
|
9 | 45 | | Session | Connecting | Checking | Done | Paused | Error |
|
10 | 46 | | ----------------- | ----------------------------------- | --------------------------------- | ---------------------------------- | ------------------------------- | ------------------------------ |
|
11 | 47 | | Anonymous |  |  |  |  |  |
|
12 | 48 | | Grammarly Account |  |  |  |  |  |
|
13 | 49 |
|
| 50 | +Check output panel for logs. |
| 51 | + |
| 52 | + |
| 53 | + |
| 54 | +Run `grammarly.restart` or **Grammarly: Restart language server** to restart the text checking service. |
| 55 | + |
14 | 56 | ## How to get help
|
15 | 57 |
|
16 | 58 | Have a question, or want to provide feedback? Use [repository discussions](https://github.com/znck/grammarly/discussions) to ask questions, share bugs or feedback, or chat with other users.
|
|
0 commit comments