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 a built-in snippet engine, syntax highlighting, and autocompletions.

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.

Modes

txtr is modal, like Vim. The current mode is shown in the statusbar.

Mode Enter
Normal Escape or Ctrl+[
Insert i I a A o O
Visual v
Visual Line V
Command :
Search /

Keybinds

Normal mode

Key Action
h j k l Move cursor
w b e Word forward / backward / end
0 $ Line start / end
gg G First / last line
Ctrl+d Ctrl+u Scroll half page down / up
dd Delete line (yanks to register)
yy Yank line
p P Paste after / before cursor
u Ctrl+r Undo / redo
x Delete character
r Replace character
> < Indent / dedent line
? Open help menu
n N Next / previous search match

Insert mode

Key Action
Tab Expand snippet or insert tab
Shift+Tab Clear snippet tab stops
Ctrl+Space Accept autocomplete
Ctrl+w Delete word before cursor
Ctrl+u Delete to line start

Visual / Visual Line mode

Key Action
y Yank selection
d Delete selection
> < Indent / dedent selection

Commands

Type : in Normal mode to enter Command mode.

Command Description
:w Save file
:q Quit
:wq Save and quit
:e <file> Open file
:help / :h Open help menu
:snippets / :snips Open snippets tab in help
:config show Open config panel
:config get <key> Print a config value
:config set <key> <value> Set a config value (persisted to disk)

Config keys use dot notation, e.g. :config set editor.tab_width 2. Section prefix is optional for unambiguous keys.

Snippets

[readme wip]

Configuration

Config lives at ~/.config/txtr/config.toml. Edit it directly or use :config set inside the editor.

[editor]

tab_width = 4
auto_pairs = true
system_clipboard = false

[theme]

name = "catppuccin"   # catppuccin, gruvbox, or custom
custom_path = ""      # path to custom theme toml (when name = "custom")

[statusbar]

show_col = true
show_mode = true

Themes

Two built-in themes: catppuccin (default) and gruvbox. Switch with:

:config set theme.name gruvbox

Restart txtr for the theme to take effect.

Custom themes — set name = "custom" and point custom_path at a TOML file defining the 17 color fields. A full template with all fields is documented in ~/.config/txtr/config.toml.

System Clipboard

By default txtr uses an internal yank register. To use the system clipboard:

:config set editor.system_clipboard true

Requires wl-copy (Wayland), xclip or xsel (X11), or pbcopy (macOS).

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-1.10.0.tar.gz (57.1 kB view details)

Uploaded Source

Built Distribution

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

texitor-1.10.0-py3-none-any.whl (66.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for texitor-1.10.0.tar.gz
Algorithm Hash digest
SHA256 91d2b65b72c7a6bed4c3f38e90497bc19ebe147eb07a1870d23e9767d64ab76b
MD5 36631fa41a9ad80e1950a9f486e7991a
BLAKE2b-256 4d361010e5834aa34faf2b44dfc16274451173f2f2c6f1355a9f219951f4390e

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for texitor-1.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9bdd123b9e5c5ffd7ec04db357cd506393baf34a23492ef80e82bb662fb937a1
MD5 484e89da480a8a88cf0af5bf8a1e4a15
BLAKE2b-256 703da2b530943b53899a5500abac6ae470e9816242746085f3e21ed33a945895

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