• This repository has been archived on 12/Aug/2023
  • Stars
    star
    154
  • Rank 236,507 (Top 5 %)
  • Language
    Lua
  • License
    Apache License 2.0
  • Created almost 3 years ago
  • Updated 10 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Grammar Guard is a Neovim plugin that checks your grammar as you write your LaTeX, Markdown or plain text document.
  _____                                _____                 __
 / ___/______ ___ _  __ _  ___ _____  / ___/_ _____ ________/ /
/ (_ / __/ _ `/  ' \/  ' \/ _ `/ __/ / (_ / // / _ `/ __/ _  / 
\___/_/  \_,_/_/_/_/_/_/_/\_,_/_/    \___/\_,_/\_,_/_/  \_,_/  
                                                               

🚧 Status

This plugin is currently on alpha stage, expect some changes to the API.

ℹī¸ Introduction

Grammar Guard is a Neovim plugin that uses ltex-ls to check your grammar.

It uses the built-in Neovim LSP to provide feedback while you're writing your LATEX or Markdown Documents.

Demo

🌟 Features

  • Easy installer, just run :GrammarInstall from Neovim (requires nvim-lsp-installer).
  • LATEX, Markdown or plain text grammar checking.
  • Integrates well with nvim-lspconfig.
  • Work properly on Windows, Linux, MacOS.

⚡ī¸ Requirements

  • Neovim >= 0.5.0

đŸ“Ļ Installation

Install via your favorite package manager:

To install grammar-guard.nvim you need to install it with your preferred neovim package manager.

packer.nvim

use {
    "brymer-meneses/grammar-guard.nvim",
    requires = {
        "neovim/nvim-lspconfig",
        "williamboman/nvim-lsp-installer"
    }
}

Run :GrammarInstall or with nvim-lsp-installer :LspInstall ltex

Run :LspInstallInfo for more information about installed servers.

⚙ī¸ Setup

Integrate the following to your neovim configuration:

-- hook to nvim-lspconfig
require("grammar-guard").init()

After that, you should tune the LSP configuration to your liking.

Example Configuration:

-- setup LSP config
require("lspconfig").grammar_guard.setup({
  cmd = { '/path/to/ltex-ls' }, -- add this if you install ltex-ls yourself
	settings = {
		ltex = {
			enabled = { "latex", "tex", "bib", "markdown" },
			language = "en",
			diagnosticSeverity = "information",
			setenceCacheSize = 2000,
			additionalRules = {
				enablePickyRules = true,
				motherTongue = "en",
			},
			trace = { server = "verbose" },
			dictionary = {},
			disabledRules = {},
			hiddenFalsePositives = {},
		},
	},
})

Disclaimer:

This plugin is largely based on the following pull request.

More Repositories

1

nvim

Personal Neovim Config
Lua
4
star
2

Mobile-COVID-19-ML-Detection

A mobile app that uses machine learning to detect COVID-19 infection from Lung CT-Scans.
Python
4
star
3

chloroplast

[WIP] A web and mobile application that uses Machine Learning to detect plant diseases from images of plant leaves.
Python
2
star
4

fourier-epicycles

Uses Discrete Fourier Transform to draw a set of connected points using Epicycles!
JavaScript
2
star
5

Playable-Flappy-Bird-with-AI

Python
2
star
6

FreeCodeCamp-Projects

This repository contains the source codes of my projects on FreeCodeCamp!
Jupyter Notebook
2
star
7

Number-Guesser-AI

A program that predicts the number you write on it!
Python
1
star
8

Autograd

My attempt in implementing the AutoGrad Algorithm in several programming languages
Python
1
star
9

Epsilon.jl

An attempt to build my own autograd library
Julia
1
star
10

Clock-Cipher

Encodes / Decodes Clock Cipher
Python
1
star
11

dotfiles

Shell
1
star
12

GDetect

[ WIP ]
JavaScript
1
star
13

brymer-meneses

1
star
14

starter-projects

A repository that contains my starter projects in a variety of programming languages!
Rust
1
star
15

Flutter-Basics

My starter projects in Flutter!
Dart
1
star
16

ML-Helper

My Machine Learning Tools
Python
1
star
17

Synapse

An attempt to build my own deep learning library using NumPy from scratch.
Python
1
star
18

TensorFlow-Basics

My beginner projects in tensorflow
Jupyter Notebook
1
star
19

glass-calculator

A fancy calculator made using vanilla HTML/CSS/JavaScript
JavaScript
1
star
20

Lexicon

1
star
21

cat-dog-mobile-classifier

Jupyter Notebook
1
star
22

latex-templates

These are my personal latex templates that I use in writing documents
Python
1
star
23

PyTorch-Basics

My basic starter projects in PyTorch!
Jupyter Notebook
1
star
24

Rust-ML

Rust
1
star