Skip to main content

A simple UI for LaTeX projects with Git support. Clone repos, edit, compile, and push.

Project description

GitLaTeX IDE

A simple web-based IDE for LaTeX projects with Git support. Create workspaces, clone repos, edit in a Monaco-powered editor, compile to PDF, and push changes—without Overleaf or the command line.


Installation

Install from PyPI:

pip install gitlatex

Requirements: Python 3.8+, and (for full use) Git and a LaTeX distribution with pdflatex (e.g. TeX Live, MiKTeX).


Quick start

gitlatex

Your browser will open at http://localhost:5000. Create a workspace or clone a repo, then open it to edit, compile, and use Git (status, diff, commit, push) from the toolbar.

Options:

Option Description
--port, -p Port (default: 5000)
--host Bind host (default: 127.0.0.1)
--no-browser Do not open the browser on start
--repos Directory for workspaces (default: ./repos in current working directory)

Example: gitlatex --port 3000 --repos /path/to/my/repos


Features

  • Workspaces – Create local folders or clone from a Git URL (e.g. GitHub).
  • File tree – Create, rename, move, delete, and upload files and folders.
  • Editor – Monaco editor, multiple tabs, resizable panels.
  • Compile – Build with pdflatex, view PDF in-app, see errors in the console.
  • Git – Status, diff, commit, and push from the Git dropdown in the toolbar.
  • Settings – Light/dark theme; optional remote Compiler API (URL + API key) to compile via a web service instead of local pdflatex.

Workflow

  1. Run gitlatex and open the app in your browser.
  2. Add a project – Create a new workspace or clone from a Git URL.
  3. Open – Click a repo to open the editor.
  4. Edit – Use the file tree and editor; click Compile to build.
  5. Git – Use the Git menu for Status, Diff, Commit, Push.

Projects are stored in the repos directory (or the path you set with --repos).


Troubleshooting

  • Compile fails – Install a LaTeX distribution and ensure pdflatex is on your PATH.
  • Port in use – Use another port: gitlatex --port 3000.
  • Windows: "The process cannot access the file... gitlatex.exe" – Another instance is running. Close it, then run gitlatex again.

Development

Run from source (no PyPI install): clone the repository, then from its root:

pip install -e .
gitlatex

Or run the package without installing:

pip install flask gitpython
python -m gitlatex

Author Note

This project was introduced to me by Atiq Bro. He was learning node. Then I kinda hijacked his project and made some ui change, added some features and then created another branch to publish it as a python package.


License

ISC

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

gitlatex-1.0.7.tar.gz (42.7 kB view details)

Uploaded Source

Built Distribution

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

gitlatex-1.0.7-py3-none-any.whl (41.9 kB view details)

Uploaded Python 3

File details

Details for the file gitlatex-1.0.7.tar.gz.

File metadata

  • Download URL: gitlatex-1.0.7.tar.gz
  • Upload date:
  • Size: 42.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.7

File hashes

Hashes for gitlatex-1.0.7.tar.gz
Algorithm Hash digest
SHA256 27c9af49f7b387d03b5490a056aff5bb53f4815fe314efff879b5aba22299100
MD5 637fd1dadc51cc19bdf247d35dcee90c
BLAKE2b-256 455be322370d2d0a4c2e66d6aaefb8eac854cc3ff235ca34da620e46a7a2aa63

See more details on using hashes here.

File details

Details for the file gitlatex-1.0.7-py3-none-any.whl.

File metadata

  • Download URL: gitlatex-1.0.7-py3-none-any.whl
  • Upload date:
  • Size: 41.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.7

File hashes

Hashes for gitlatex-1.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 eb5fb25caff3a2e9834844483b60ee441333c8a576092dd740b19af971b50e32
MD5 41a1fa7ef62157d6ee0e1fafbab1ae87
BLAKE2b-256 72d3cc08331134e4cc015576b4898348f2d561b592d94b941469de534fcb3a35

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