Repository navigation
Home
tift is a configurable formatter for LaTeX and BibTeX source, available as a command-line program and a Rust library. It formats .tex, .tikz, .sty, .cls, .bib, .dtx, and .ins files on Windows, Linux, and macOS.
Supported CJK syntax includes ctex, xeCJK, xeCJKfntef, xpinyin, zhnumber, zhlipsum, CJK, CJKfntef, CJKnumb, and luatexja-fontspec. Font options, pronunciation data, Chinese numerals, CJK environments, and underline annotations remain intact while surrounding source is formatted.
Install tift, then preview a document with tift --diff main.tex. Defaults use four-space indentation, recognized table column specifications, formula whitespace formatting, bibliography layout, and algorithm2e/expl3 layout. Prose line breaks are preserved; bibliography sorting and data cleanup are disabled. Local command definitions and project imports supply environment aliases and signatures.
| Page | Contents |
|---|---|
| Getting started | Requirements, installation, first format, and project setup |
| Command line | All options, input modes, exit codes, backups, and safe writes |
| Configuration setup | File locations, TOML syntax, inheritance, and per-file overrides |
| Configuration | Complete TOML reference, defaults, inheritance, and overrides |
| Formatting | Indentation, alignment, wrapping, arguments, and BibTeX examples |
| Formatting examples | Input/output gallery with common formats, custom syntax, replacements, and line selections |
| BibTeX and BibLaTeX | Normalization, field ordering, and configurable entry sorting |
| Formula formatting | Operator spacing, scripts, and displayed formula breaks |
| Table column alignment | Column specifications, tabularray rules, and spans |
| Code and docstrip formatting | algorithm2e, expl3, documented TeX sources, and installation scripts |
| Project context | Roots, local imports, declaration inference, and custom syntax |
| Source analysis | Lossless snapshots, aliases, shared rules and conservative diagnostics |
| Supported syntax | Package families, literal protection, and analysis limits |
| Editor integration | LaTeX Workshop, Neovim, pre-commit, and LaTeX-project CI |
| VS Code / LaTeX Workshop | Setup steps, copyable settings, formatting on save, and troubleshooting |
| Library API | Rust integration, results, diagnostics, ranges, and traces |
| Cache and tracing | Storage, invalidation, line selections, and diagnosis |
| Project processing | Dependency preparation, worker threads, and repeated runs |
| Building from source | Local builds, installation, and API documentation |
| Troubleshooting | Configuration, unusual syntax, output, and installation issues |
tift --check .
tift --diff main.tex
tift --show-config main.tex
tift --dump-config > tift.toml
tift --wrap --wrap-width 88 main.tex
tift --rewrap --wrap-width 88 main.tex
tift - --stdin-filename main.textift
- Home
- Getting started
- Command line
- Configuration setup
- Configuration reference
- Formatting
- Formatting examples
- BibTeX and BibLaTeX
- Formula formatting
- Table column alignment
- Code and docstrip formatting
- Project context
- Source analysis
- Supported syntax
- Editor integration
- VS Code / LaTeX Workshop
- Library API
- Cache and tracing
- Performance
- Building from source
- Troubleshooting