LaTeXBuddy

The only LaTeX checking tool you’ll ever need.

LaTeXBuddy is the checking tool for LaTeX, which combines the power of various other tools in one easy-to-use command-line tool with clear HTML output. Aspell, ChkTeX, LanguageTool: you name it! LaTeXBuddy is modular and Python-based, so that implementing new functionality becomes a breeze!

Important

LaTeXBuddy is a work in progress. We are working on fixing bugs and cleaning up. Using LaTeXBuddy in its current state may come with a lot of inconveniences. Upon reaching the Beta status, we will open-source this project. For now, it technically remains copyrighted, yet you’re free to fork it and provide your edits and improvements to the code base.

---

User’s guide

Tutorial

• Install
  • GITZ registry
• Build from source
  • With Docker

How do I...

• ...develop my own module?
  • Create a Python file for your module
  • Working with TexFile
  • Working with Problem
  • Further Information
• ...use the API?
  • Using the ConfigLoader
  • Using the included utilities

Reference

• Command-line interface
  • Named Arguments
• API Reference
  • Main instance
  • Configuration
  • TeX file
  • Modules
  • Problems
  • Output
  • Preprocessing
  • Utilities
• Built-in modules
  • aspell
  • BibTeX
  • ChkTeX
  • Diction
  • LanguageTool
  • Log filter
  • Own checkers
  • Proselint
  • Yalafi
• Server API Reference
  • FlaskConfigLoader

Developer’s guide

Developer's guide

• Environment setup
  • OS
  • Code Editor
  • Git
  • Python
  • Poetry
  • pre-commit