Code Monkey home page Code Monkey logo

quietex's Introduction

QuieTeX

PyPI Package latest release Supported versions

Make your LaTeX build output just show the important stuff (see here for before and after screen recordings): Screenshot of LaTeX build output from a chapter of my thesis

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:

pip3 install quietex

To use:

quietex pdflatex test.tex

To use with latexmk, add this to your latexmkrc:

# Make output prettier
eval `quietex --latexmkrc`;

Development

To install in editable mode:

pip3 install -e .

Use pre-commit to check and format changes before committing:

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 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 would be an easy drop-in for the status bar

The approach for colouring latexmk messages is inspired by this Stack Overflow answer. The way I've packaged latexmkrc is taken straight from mje-nz/pythontexfigures, my library for generating good-looking figures by integrating Python scripts into LaTeX documents.

quietex's People

Contributors

mje-nz avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  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.