Skip to main content

A Vim-style LaTeX TUI editor.

Project description

txtr screenshot

A Vim-style LaTeX editor for the terminal.

txtr screenshot

Documentation | PyPI


txtr (aka texitor) is a terminal-based LaTeX editor built for speed. It combines Vim-style modal editing with snippets, completions, citations, compiler tooling, and a growing plugin system.

Under active development. Expect bugs :)

Installation

pip install texitor

Requires Python 3.11 or later.

Usage

txtr file.tex

If the file does not exist, txtr creates it. Config and snippets are seeded to ~/.config/txtr/ on first run.

Whats in txtr ???

  • Vim-style modal editing for .tex files
  • LaTeX snippets and completions
  • citation autocomplete from .bib files
  • compiler commands and build/watch flows
  • built-in + installable plugins
  • a full docs site with config, snippets, and plugin guides

Quick start

txtr file.tex

Config and snippets are seeded into ~/.config/txtr/ on first run.

Inside txtr:

  • ? opens the help menu
  • : opens command mode
  • :snippets jumps straight to snippet help
  • :config show opens the config panel
  • :plugin list shows installed plugins

IF YOU GET STUCK, READ THE DOCS! (click me)

Documentation

The full docs live at txtr.benji.mom.

Useful starting points:

Notes

  • requires Python 3.11+
  • compiler features expect tools like latexmk or pdflatex to be installed
  • system clipboard features rely on platform clipboard tools

Contributing

txtr is early-stage. If you find a bug or want to add something, open an issue or PR on GitHub.

tl;dr - just make a pr ...

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

texitor-2.1.0.tar.gz (73.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

texitor-2.1.0-py3-none-any.whl (86.7 kB view details)

Uploaded Python 3

File details

Details for the file texitor-2.1.0.tar.gz.

File metadata

  • Download URL: texitor-2.1.0.tar.gz
  • Upload date:
  • Size: 73.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for texitor-2.1.0.tar.gz
Algorithm Hash digest
SHA256 1539d7732f6b853523acc51780c9ed3cd57238e167467c04e7228ac8c121fd7d
MD5 33d2a90102a62b79db606d6c1e8ee2f2
BLAKE2b-256 b774b658b45c1e668d59dd0abe385ffe980e55f66db2ab5dad0d6faaad01555b

See more details on using hashes here.

File details

Details for the file texitor-2.1.0-py3-none-any.whl.

File metadata

  • Download URL: texitor-2.1.0-py3-none-any.whl
  • Upload date:
  • Size: 86.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for texitor-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 53756dc8e32c5cdc2fab8f33a9adfa4663c5c95bb15d84b8d2153f1f36b99e9c
MD5 7498a4753c68ae5d4d37762d250baaa9
BLAKE2b-256 d54031e8cb8cd203c28bb4456281a96198fc0efb1c5e8c39a3c5f7a31a2ad8ad

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page