Giter Club home page Giter Club logo

linter-yalafi's Introduction

linter-yalafi - Checks your LaTeX documents

linter-yalafi is an Atom package that lints LaTeX documents with respect to grammar and spelling using LanguageTool. To filter any LaTeX commands YaLafi is used.

Installation

Using the Atom package manager:

apm install lint-yalafi

You also have to install linter:

apm install linter

Since this is an interface to YaLafi it also has to be installed. The easiest way is to use pip:

pip install yalafi

Using a local LanguageTool Server

If you do not want to use the LanguageTool online server you also need to install Java and LanguageTool. More information on how to install LanguageTool can be found here.

Then you can set the 'LanguageTool path' in the settings. It should point to the directory containing e.g. 'languagetool-server.jar'. This package will then start the server if it is not already running. You can also start the server manually by invoking YaLafi yourself, e.g. with python -m yalafi.shell --lt-server my file.tex.

For even better spell-checking one can use n-gram data to find errors with words that are often confused. More information and the n-gram data can be found here. After downloading and unzipping, you have to set the 'LanguageTool path for n-gram data' in the settings.

Important: The 'LanguageTool server options' and also the n-gram data path is only used at first server startup. Just changing the settings will not give you any results unless you manually kill the server.

linter-yalafi's People

Contributors

torik42 avatar

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.