https://github.com/mje-nz/quietex
Make your LaTeX build output just show the important stuff.
https://github.com/mje-nz/quietex
colour filter latex latexmk output pdflatex prettier
Last synced: 7 months ago
JSON representation
Make your LaTeX build output just show the important stuff.
- Host: GitHub
- URL: https://github.com/mje-nz/quietex
- Owner: mje-nz
- Created: 2019-07-30T03:02:17.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-02-26T11:10:48.000Z (almost 5 years ago)
- Last Synced: 2025-04-30T03:46:52.603Z (7 months ago)
- Topics: colour, filter, latex, latexmk, output, pdflatex, prettier
- Language: Python
- Homepage:
- Size: 373 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# QuieTeX
[](https://pypi.org/project/quietex)
[](https://pypi.org/project/quietex)
Make your LaTeX build output just show the important stuff (see [here](/screen-recordings.md) for before and after screen recordings):
QuieTeX is a minimal command-line tool which filters and colourizes the output of `pdflatex` in real-time.
It is not a build tool, it does not do any clever summaries, it just makes it easier to read.
## Features
* Hides open/close file logging
* Colours errors red
* Colours warnings yellow
* TeX input prompt works in `errorstopmode` and `scrollmode`
* `latexmk` integration
## Usage
To install:
```bash
pip3 install quietex
```
To use:
```bash
quietex pdflatex test.tex
```
To use with `latexmk`, add this to your `latexmkrc`:
```perl
# Make output prettier
eval `quietex --latexmkrc`;
```
## Development
To install in editable mode:
```bash
pip3 install -e .
```
Use [pre-commit](https://pre-commit.com) to check and format changes before committing:
```bash
pip install pre-commit
pre-commit install
```
## Misc
TODO:
* Show open-files stack before warnings and errors
* Display page numbers in real-time, before the end of the line
* Completions for TeX prompt
* Syntax highlighting for TeX snippets
* Configurable styles
* Collapse multiple blank lines, maybe remove all blank lines between single-line warnings
* Recognise multi-line warnings with (package name) continuations
* Highlight "Output written on" message
* Detect VS Code using [$TERM_PROGRAM](https://stackoverflow.com/a/57789690) and disable colours, since it doesn't support them in the output window and doesn't distinguish between the output window and the terminal
* See if [rich](https://github.com/willmcgugan/rich#status) would be an easy drop-in for the status bar
The approach for colouring `latexmk` messages is inspired by [this Stack Overflow answer](https://tex.stackexchange.com/a/406370).
The way I've packaged `latexmkrc` is taken straight from [mje-nz/pythontexfigures](https://github.com/mje-nz/pythontexfigure), my library for generating good-looking figures by integrating Python scripts into LaTeX documents.