Skip to content

Litrepl is a command-line tool and Vim plugin for evaluating code sections within Markdown or LaTeX documents.

License

Notifications You must be signed in to change notification settings

sergei-mironov/litrepl

Repository files navigation

⌨️ LitRepl ⌨️

Changelog | Installation | Usage | Gallery

Litrepl tests

Litrepl is acommand-line processor for Markdown or LaTeX documents with literate programming code sections. Instructed by its arguments, it evaluates and updates sections via background interpreters. Interpreters can stay active for a read-eval-paste-loop style.

Peek 2024-07-18 20-50-2

Notes:

PDF Icon Preprint: (2025, Sergei Mironov) Litrepl: Literate Paper Processor Promoting Transparency More Than Reproducibility arXiv:2501.10738

Features

Requirements

  • POSIX-compatible OS, typically a Linux. The tool relies on POSIX operations, notably pipes, and depends on certain Shell commands.
  • lark-parser and psutil Python packages.
  • Socat (Optional) Needed for litrepl repl and Vim's LTerm commands to work.

Documentation

For full documentation, check out the project's GitHub Pages site.

Gallery

Basic usage (Show GIF)

Peek 2024-07-18 20-50-2

(Outdated!) AI capabilities (Show GIF)

Peek 2024-11-28 20-48

Vimtex integration (Show Video)

We utilize LitRepl alongside the Vimtex plugin to edit and preview LaTeX documents instantly.

demo-vimtex.mp4

About

Litrepl is a command-line tool and Vim plugin for evaluating code sections within Markdown or LaTeX documents.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published