How do I ignore specific warnings in TeXtidote?

Use the --ignore flag followed by rule IDs, like --ignore sh:001. Rule IDs are shown in reports, and multiple IDs can be separated by commas without spaces. You can also use configuration files for repeated use.

TeXtidote vs. Vale for Markdown style checking?

TeXtidote excels with LaTeX and integrates grammar checking via Language Tool, while Vale is more customizable for style guides but may not handle LaTeX. Choose TeXtidote if you work with mixed LaTeX/Markdown or need robust grammar checks.

Can TeXtidote check documents in real-time as I type?

No, TeXtidote is a command-line tool; for real-time checking, you need to integrate it with editors like VS Code or Emacs using provided snippets, which requires additional setup and isn't as seamless as built-in linters.

How to check spelling and grammar in multiple languages?

Use the --check option with a two-letter language code, and --firstlang for false friends. For example, --check en --firstlang de checks English with German false friend detection, leveraging Language Tool's multi-language support.

Does TeXtidote work with large LaTeX projects with multiple files?

Yes, it automatically follows \input and \include commands, but for complex file structures, you might need to use --root or pre-processing tools, as noted in the README's section on reading sub-files.

What's the performance impact of using TeXtidote?

Performance depends on document length and Language Tool usage; --check increases analysis time significantly, but reports show total time, so it's manageable for typical academic papers but may slow down on very large documents.

Open-Awesome

TeXtidote

GPL-3.0Javav0.9

A grammar and style checker for LaTeX and Markdown documents that preserves source file location mapping.

Visit Website GitHub

1.0k stars73 forks0 contributors

Overview

Spelling, grammar and style checking on LaTeX documents

Use Cases

Not Ideal For

Writers needing real-time, inline grammar checking while editing in an IDE.
Projects using markup formats other than LaTeX or Markdown (e.g., HTML, AsciiDoc).
Users requiring highly customizable grammar rules beyond what Language Tool offers.
Teams with complex LaTeX documents that use unsupported macros, necessitating frequent manual ignore directives.

Pros & Cons

Pros

Markup-Aware Grammar Checking

TeXtidote uniquely cleans LaTeX and Markdown markup while mapping errors back to source locations, enabling precise grammar checks on structured documents without losing context.

LaTeX-Specific Rule Enforcement

Includes custom rules for LaTeX conventions like capitalizing titles, proper citation spacing, and figure referencing, which general grammar tools miss, as listed in the README's rule section.

Language Tool Integration

Leverages the extensive Language Tool library for spelling and grammar checks in multiple languages, providing comprehensive linguistic analysis beyond basic spellchecking.

Flexible Output and Integration

Supports HTML, console, and single-line report formats, facilitating integration with CI pipelines, editors, and other tools, as demonstrated with VS Code and Emacs examples.

Cons

Java Runtime Dependency

Requires Java 8 or later installed, adding an extra layer of setup and potential compatibility issues compared to native or web-based tools, which may deter users on lightweight systems.

Complex LaTeX Handling Limitations

Struggles with certain LaTeX constructs like multi-line command arguments or hard-wrapped paragraphs, forcing users to adopt specific formatting or use ignore comments, as admitted in the 'Helping TeXtidote' section.

Limited to Language Tool's Scope

Grammar checking capabilities are bounded by Language Tool's rules and language support, so niche or unsupported languages may not be adequately covered, and advanced customization requires external configurations.

Open Source Alternative To

TeXtidote is an open-source alternative to the following products:

Antidote

Antidote is a command-line package manager for Zsh plugins and themes, designed to be fast and simple. It clones plugins from GitHub and other sources to manage Zsh configurations.

Frequently Asked Questions

Related Projects

blacktex

:black_heart: Cleans up your LaTeX files.

Stars159

Forks11

Last commit2 years ago

ChkTeX

Linter / code checker for LaTeX documents. foss

Stars0

Forks0

Last commit

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub