gitlatex 1.10.0__tar.gz → 2.0.0__tar.gz

{gitlatex-1.10.0 → gitlatex-2.0.0}/.github/workflows/publish.yml

@@ -50,6 +50,20 @@ jobs:
           # Tags pushed with GITHUB_TOKEN don't re-trigger workflows, so no double publish.
           git push origin "$NEXT"
 
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "22"
+          cache: npm
+          cache-dependency-path: web/package-lock.json
+
+      # The editor UI (web/) is built into gitlatex/ui, which the wheel ships.
+      - name: Build and test the editor UI
+        working-directory: web
+        run: |
+          npm ci
+          npm test
+          npm run build
+
       - uses: actions/setup-python@v5
         with:
           python-version: "3.12"
@@ -59,6 +73,9 @@ jobs:
           python -m pip install --upgrade build twine
           python -m build
           python -m twine check dist/*
+          # Fail rather than publish a package without its UI or engine manifest.
+          unzip -l dist/*.whl | grep -q "gitlatex/ui/index.html"
+          unzip -l dist/*.whl | grep -q "gitlatex/engine/manifest.json"
 
       - name: Make sure the build got a clean release version
         id: version

{gitlatex-1.10.0 → gitlatex-2.0.0}/.gitignore

@@ -20,3 +20,6 @@ pypirc.example
 
 # Generated by setuptools-scm
 gitlatex/_version.py
+
+# Editor UI built from web/ (npm run build)
+gitlatex/ui/

gitlatex-2.0.0/MANIFEST.in

@@ -0,0 +1,4 @@
+# The editor UI ships prebuilt in gitlatex/ui (package data); its sources in
+# web/ and the test repos stay out of the sdist.
+prune web
+prune repos

{gitlatex-1.10.0/gitlatex.egg-info → gitlatex-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitlatex
-Version: 1.10.0
+Version: 2.0.0
 Summary: A simple UI for LaTeX projects with Git support. Clone repos, edit, compile, and push.
 License-Expression: ISC
 Project-URL: Homepage, https://github.com/abdussamiakanda/gitlatex
@@ -53,12 +53,15 @@ Git repository. Your `.tex` files are just files, and your history is just Git.
 
 - **Your files stay yours.** Plain folders on your disk, versioned with real Git.
 - **No account, no subscription, no upload cap.**
-- **Compiles locally**, so your unpublished work never leaves your machine.
+- **Compiles locally**, so your unpublished work never leaves your machine —
+  with your own TeX installation, or with **TeX Live running in the browser**
+  when you have none.
 - **One command to start.** `pip install gitlatex && gitlatex`.
 
-> The editor itself (Monaco), the icon set and the web fonts are loaded from a
-> CDN, so the interface needs a network connection the first time it is opened
-> on a machine. Everything else — your files, compiling, and Git — is local.
+> The in-browser TeX engine (~190 MB) and any extra LaTeX packages it needs
+> are downloaded on first use and cached in `~/.gitlatex`, so compiling without
+> a TeX installation needs a network connection once. Everything else — your
+> files, the editor, and Git — is local.
 
 ---
 
@@ -73,11 +76,25 @@ pip install gitlatex
 | | |
 | --- | --- |
 | Python | 3.8 or newer |
-| LaTeX | A distribution providing `pdflatex` — [TeX Live](https://www.tug.org/texlive/), [MiKTeX](https://miktex.org/), or [MacTeX](https://www.tug.org/mactex/) |
+| LaTeX | Optional — [TeX Live](https://www.tug.org/texlive/), [MiKTeX](https://miktex.org/) or [MacTeX](https://www.tug.org/mactex/). Without one, documents compile in the browser |
 | Git | Required for cloning, pushing and version history |
 
-LaTeX and Git are optional if you only want to edit files, but compiling and the
-Git features need them on your `PATH`.
+### Compilers
+
+**Settings → Compiler** picks where documents are built:
+
+| | |
+| --- | --- |
+| **Auto** (default) | Local TeX when `pdflatex`/`xelatex`/`lualatex` is on your `PATH`, otherwise the browser |
+| **In the browser** | Real TeX Live 2022 (pdfTeX, XeTeX, BibTeX, makeindex) compiled to WebAssembly, from [BusyTeX](https://github.com/busytex/busytex). Missing packages (TikZ, biblatex, extra fonts…) are fetched on demand from a package shelf. No LuaLaTeX, no biber (use `backend=bibtex`), no shell escape |
+| **Local TeX** | Your TeX installation, with bibtex/biber |
+| **Compiler API** | A remote web service that compiles LaTeX (same format as before; see the classic editor's Settings → Compiler API) |
+
+Browser builds write `main.pdf` and its SyncTeX data into the project folder,
+just like local builds. `gitlatex --fetch-engine` downloads the engine ahead of
+time (for example before going offline). The package shelf defaults to the one
+published by [TexBrowser IDE](https://github.com/jukomol/TexBrowser-IDE); point
+`GITLATEX_SHELF_URL` elsewhere, or set it empty to disable on-demand packages.
 
 ---
 
@@ -209,20 +226,19 @@ powers VS Code.
 ### Vim mode with VimTeX-style mappings
 
 Turn on **Settings → Editor → Vim keybindings** for normal, insert and visual
-modes, with `:w` to save. On top of that, the parts of
+modes, with `:w` to save. In `.tex` files you also get the parts of
 [VimTeX](https://github.com/lervag/vimtex) people use every day:
 
 | | Keys |
 | --- | --- |
-| Text objects | `ie`/`ae` environment · `i$`/`a$` math · `ic`/`ac` command · `id`/`ad` delimiters · `iP`/`aP` section |
-| Motions | `]]` `[[` sections · `]m` `[m` `\begin` · `]M` `[M` `\end` · `]n` `[n` math · `%` jumps between `\begin` and `\end` |
-| Delete / change / toggle | `dse` `cse` `tse` environment · `dsc` `csc` `tsc` command · `ds$` `cs$` `ts$` math · `dsd` `tsd` `\left…\right` · `tsf` `\frac{a}{b}` ↔ `a/b` |
+| Text objects | `ie`/`ae` environment · `i$`/`a$` math · `ic`/`ac` command · `id`/`ad` delimiters · `iP`/`aP` section · `im`/`am` item |
+| Motions | `]]` `[[` `][` `[]` sections · `]m` `[m` `]M` `[M` environments · `]n` `[n` `]N` `[N` math · `]r` `[r` `]R` `[R` frames · `]*` `[*` comments · `%` |
+| Delete / change / toggle | `dse` `cse` `tse` `tss` environment · `dsc` `csc` `tsc` command · `ds$` `cs$` `ts$` math · `dsd` `csd` `tsd` delimiters · `tsf` fractions · `tsb` `\\` |
 | Leader commands | `\ll` compile · `\lv` show in PDF · `\lt` outline · `\le` errors |
 | Insert mode | `]]` closes the current environment |
 | Ex commands | `:VimtexCompile` · `:VimtexView` · `:VimtexToc` · `:VimtexErrors` |
 
-Comments are ignored when matching environments, so a commented-out `\begin`
-never pairs with a real `\end`. The full table is also in Settings.
+See [docs/vim-mode.md](docs/vim-mode.md) for what each key does, with examples.
 
 ### Review comments
 
@@ -291,8 +307,27 @@ pip install -e .
 gitlatex
 ```
 
-There is **no build step**. The browser loads the ES modules directly, so editing
-a file and reloading the page is the entire feedback loop.
+The editor UI lives in `web/` (React + TypeScript + Vite) and is built into
+`gitlatex/ui/`, which the server serves at `/`. It needs Node 22+:
+
+```bash
+cd web
+npm install
+npm run build        # → gitlatex/ui (then run `gitlatex` as usual)
+npm run dev          # hot reload on :5173, proxying the API to `gitlatex --no-browser` on :5000
+npm test             # unit tests (vitest)
+npm run e2e:gitlatex -- http://127.0.0.1:5000 /tmp/gl-e2e   # browser tests: run `gitlatex --repos /tmp/gl-e2e` first
+npm run e2e:features -- http://127.0.0.1:5000 /tmp/gl-e2e  # (and e2e:synctex); they create projects, so never ./repos
+```
+
+The previous vanilla-JS editor is still served at `/classic` (no build step).
+Vim mode, review comments, spell checking and snippets have been ported to the
+new UI and share their settings, snippets and dictionary with it. An install
+without a built UI falls back to the classic editor.
+
+`web/` started as [TexBrowser IDE](https://github.com/jukomol/TexBrowser-IDE)
+(MIT, see `web/LICENSE-texbrowser`); its browser storage and GitHub sync were
+replaced by gitlatex's folders and Git.
 
 ### Project layout
 
@@ -319,13 +354,27 @@ front of it.
 | `services/updates.py` | The cached PyPI version check |
 | `services/comments.py` | Review comment threads, stored in `.gitlatex/comments/` |
 | `services/gitrepo.py`, `services/git_backend.py` | Shared GitPython plumbing |
+| `routes/workspace.py` | The file API the editor UI uses (open a project, write/move/delete files) |
+| `routes/engine.py` | Serves the in-browser TeX engine and package shelf, downloading and caching them in `~/.gitlatex` |
+| `engine/manifest.json` | The engine's file list and checksums, generated by `web/scripts/fetch-engine.mjs` |
 | `routes/` | One blueprint per area — see `routes/__init__.py` |
 
 To add an endpoint: put the logic in `services/`, then a short handler in the
 matching `routes/*.py`. `routes/pages.py` registers last, because its catch-all
 serves `index.html` for unknown paths.
 
-**Front end** (`gitlatex/public/`)
+**Editor UI** (`web/src/`)
+
+| Path | What lives there |
+| --- | --- |
+| `state/actions.ts` | Every user-facing operation: projects, files, compiling (browser / local / API), Git |
+| `state/workspace.ts` | The open project in memory, written back to disk through one ordered queue |
+| `storage/server.ts` | Typed client for the gitlatex server |
+| `engine/` | The WebAssembly TeX engine: worker, latexmk-style compile loop, package shelf |
+| `editor/`, `pdf/`, `latex/` | Monaco setup and LaTeX language features, the pdf.js viewer, log parsing and SyncTeX |
+| `components/` | Panels, dialogs, the projects home, Git panels |
+
+**Classic front end** (`gitlatex/public/`, served at `/classic`)
 
 | Path | What lives there |
 | --- | --- |

{gitlatex-1.10.0 → gitlatex-2.0.0}/README.md

@@ -25,12 +25,15 @@ Git repository. Your `.tex` files are just files, and your history is just Git.
 
 - **Your files stay yours.** Plain folders on your disk, versioned with real Git.
 - **No account, no subscription, no upload cap.**
-- **Compiles locally**, so your unpublished work never leaves your machine.
+- **Compiles locally**, so your unpublished work never leaves your machine —
+  with your own TeX installation, or with **TeX Live running in the browser**
+  when you have none.
 - **One command to start.** `pip install gitlatex && gitlatex`.
 
-> The editor itself (Monaco), the icon set and the web fonts are loaded from a
-> CDN, so the interface needs a network connection the first time it is opened
-> on a machine. Everything else — your files, compiling, and Git — is local.
+> The in-browser TeX engine (~190 MB) and any extra LaTeX packages it needs
+> are downloaded on first use and cached in `~/.gitlatex`, so compiling without
+> a TeX installation needs a network connection once. Everything else — your
+> files, the editor, and Git — is local.
 
 ---
 
@@ -45,11 +48,25 @@ pip install gitlatex
 | | |
 | --- | --- |
 | Python | 3.8 or newer |
-| LaTeX | A distribution providing `pdflatex` — [TeX Live](https://www.tug.org/texlive/), [MiKTeX](https://miktex.org/), or [MacTeX](https://www.tug.org/mactex/) |
+| LaTeX | Optional — [TeX Live](https://www.tug.org/texlive/), [MiKTeX](https://miktex.org/) or [MacTeX](https://www.tug.org/mactex/). Without one, documents compile in the browser |
 | Git | Required for cloning, pushing and version history |
 
-LaTeX and Git are optional if you only want to edit files, but compiling and the
-Git features need them on your `PATH`.
+### Compilers
+
+**Settings → Compiler** picks where documents are built:
+
+| | |
+| --- | --- |
+| **Auto** (default) | Local TeX when `pdflatex`/`xelatex`/`lualatex` is on your `PATH`, otherwise the browser |
+| **In the browser** | Real TeX Live 2022 (pdfTeX, XeTeX, BibTeX, makeindex) compiled to WebAssembly, from [BusyTeX](https://github.com/busytex/busytex). Missing packages (TikZ, biblatex, extra fonts…) are fetched on demand from a package shelf. No LuaLaTeX, no biber (use `backend=bibtex`), no shell escape |
+| **Local TeX** | Your TeX installation, with bibtex/biber |
+| **Compiler API** | A remote web service that compiles LaTeX (same format as before; see the classic editor's Settings → Compiler API) |
+
+Browser builds write `main.pdf` and its SyncTeX data into the project folder,
+just like local builds. `gitlatex --fetch-engine` downloads the engine ahead of
+time (for example before going offline). The package shelf defaults to the one
+published by [TexBrowser IDE](https://github.com/jukomol/TexBrowser-IDE); point
+`GITLATEX_SHELF_URL` elsewhere, or set it empty to disable on-demand packages.
 
 ---
 
@@ -181,20 +198,19 @@ powers VS Code.
 ### Vim mode with VimTeX-style mappings
 
 Turn on **Settings → Editor → Vim keybindings** for normal, insert and visual
-modes, with `:w` to save. On top of that, the parts of
+modes, with `:w` to save. In `.tex` files you also get the parts of
 [VimTeX](https://github.com/lervag/vimtex) people use every day:
 
 | | Keys |
 | --- | --- |
-| Text objects | `ie`/`ae` environment · `i$`/`a$` math · `ic`/`ac` command · `id`/`ad` delimiters · `iP`/`aP` section |
-| Motions | `]]` `[[` sections · `]m` `[m` `\begin` · `]M` `[M` `\end` · `]n` `[n` math · `%` jumps between `\begin` and `\end` |
-| Delete / change / toggle | `dse` `cse` `tse` environment · `dsc` `csc` `tsc` command · `ds$` `cs$` `ts$` math · `dsd` `tsd` `\left…\right` · `tsf` `\frac{a}{b}` ↔ `a/b` |
+| Text objects | `ie`/`ae` environment · `i$`/`a$` math · `ic`/`ac` command · `id`/`ad` delimiters · `iP`/`aP` section · `im`/`am` item |
+| Motions | `]]` `[[` `][` `[]` sections · `]m` `[m` `]M` `[M` environments · `]n` `[n` `]N` `[N` math · `]r` `[r` `]R` `[R` frames · `]*` `[*` comments · `%` |
+| Delete / change / toggle | `dse` `cse` `tse` `tss` environment · `dsc` `csc` `tsc` command · `ds$` `cs$` `ts$` math · `dsd` `csd` `tsd` delimiters · `tsf` fractions · `tsb` `\\` |
 | Leader commands | `\ll` compile · `\lv` show in PDF · `\lt` outline · `\le` errors |
 | Insert mode | `]]` closes the current environment |
 | Ex commands | `:VimtexCompile` · `:VimtexView` · `:VimtexToc` · `:VimtexErrors` |
 
-Comments are ignored when matching environments, so a commented-out `\begin`
-never pairs with a real `\end`. The full table is also in Settings.
+See [docs/vim-mode.md](docs/vim-mode.md) for what each key does, with examples.
 
 ### Review comments
 
@@ -263,8 +279,27 @@ pip install -e .
 gitlatex
 ```
 
-There is **no build step**. The browser loads the ES modules directly, so editing
-a file and reloading the page is the entire feedback loop.
+The editor UI lives in `web/` (React + TypeScript + Vite) and is built into
+`gitlatex/ui/`, which the server serves at `/`. It needs Node 22+:
+
+```bash
+cd web
+npm install
+npm run build        # → gitlatex/ui (then run `gitlatex` as usual)
+npm run dev          # hot reload on :5173, proxying the API to `gitlatex --no-browser` on :5000
+npm test             # unit tests (vitest)
+npm run e2e:gitlatex -- http://127.0.0.1:5000 /tmp/gl-e2e   # browser tests: run `gitlatex --repos /tmp/gl-e2e` first
+npm run e2e:features -- http://127.0.0.1:5000 /tmp/gl-e2e  # (and e2e:synctex); they create projects, so never ./repos
+```
+
+The previous vanilla-JS editor is still served at `/classic` (no build step).
+Vim mode, review comments, spell checking and snippets have been ported to the
+new UI and share their settings, snippets and dictionary with it. An install
+without a built UI falls back to the classic editor.
+
+`web/` started as [TexBrowser IDE](https://github.com/jukomol/TexBrowser-IDE)
+(MIT, see `web/LICENSE-texbrowser`); its browser storage and GitHub sync were
+replaced by gitlatex's folders and Git.
 
 ### Project layout
 
@@ -291,13 +326,27 @@ front of it.
 | `services/updates.py` | The cached PyPI version check |
 | `services/comments.py` | Review comment threads, stored in `.gitlatex/comments/` |
 | `services/gitrepo.py`, `services/git_backend.py` | Shared GitPython plumbing |
+| `routes/workspace.py` | The file API the editor UI uses (open a project, write/move/delete files) |
+| `routes/engine.py` | Serves the in-browser TeX engine and package shelf, downloading and caching them in `~/.gitlatex` |
+| `engine/manifest.json` | The engine's file list and checksums, generated by `web/scripts/fetch-engine.mjs` |
 | `routes/` | One blueprint per area — see `routes/__init__.py` |
 
 To add an endpoint: put the logic in `services/`, then a short handler in the
 matching `routes/*.py`. `routes/pages.py` registers last, because its catch-all
 serves `index.html` for unknown paths.
 
-**Front end** (`gitlatex/public/`)
+**Editor UI** (`web/src/`)
+
+| Path | What lives there |
+| --- | --- |
+| `state/actions.ts` | Every user-facing operation: projects, files, compiling (browser / local / API), Git |
+| `state/workspace.ts` | The open project in memory, written back to disk through one ordered queue |
+| `storage/server.ts` | Typed client for the gitlatex server |
+| `engine/` | The WebAssembly TeX engine: worker, latexmk-style compile loop, package shelf |
+| `editor/`, `pdf/`, `latex/` | Monaco setup and LaTeX language features, the pdf.js viewer, log parsing and SyncTeX |
+| `components/` | Panels, dialogs, the projects home, Git panels |
+
+**Classic front end** (`gitlatex/public/`, served at `/classic`)
 
 | Path | What lives there |
 | --- | --- |

gitlatex-2.0.0/docs/vim-mode.md

@@ -0,0 +1,179 @@
+# Vim mode and VimTeX-style keybindings
+
+gitlatex's editor has an optional Vim mode, built on
+[monaco-vim](https://github.com/brijeshb42/monaco-vim), with a layer of
+[VimTeX](https://github.com/lervag/vimtex)-style mappings for LaTeX on top.
+
+- **Turn it on:** **Settings → Editor → Vim keybindings**. It is off by default,
+  and monaco-vim is only downloaded the first time you switch it on.
+- **Where the VimTeX keys work:** only in TeX files (`.tex`, `.sty`, `.cls`,
+  `.ltx`, `.dtx`). In every other file (`.md`, `.bib`, …) the same keys do
+  whatever plain Vim does. See [Standard Vim](#standard-vim-every-file).
+- **Comments are ignored:** a `\begin`, `\end`, `$` or bracket inside a `%`
+  comment never pairs with a real one.
+
+The code lives in `web/src/editor/vimtex.ts` (the VimTeX layer) and
+`web/src/editor/vim.ts` (loading monaco-vim, ex commands). The classic editor
+at `/classic` has the same keys, in `gitlatex/public/js/editor/`. A shorter
+table is also in Settings.
+
+## Text objects
+
+Text objects don't do anything on their own. Put one after an operator (`d`
+delete, `c` change, `y` copy, `>` indent, …) or use it in visual mode (`v`).
+`i…` means *inside*, `a…` means *around* (including the delimiters).
+
+| Keys | Object |
+| --- | --- |
+| `ie` `ae` | LaTeX environment (`\begin{…}` … `\end{…}`) |
+| `i$` `a$` | Math: `$…$`, `$$…$$`, `\(…\)`, `\[…\]`, and math environments (`equation`, `align`, `gather`, `multline`, …, starred or not) |
+| `ic` `ac` | Command: `ic` is the argument the cursor is in (or the first `{}` argument); `ac` is the whole `\name*[…]{…}` |
+| `id` `ad` | Delimiters: `()`, `[]`, `{}`, `\{\}`; `ad` also takes `\left`/`\right` or `\bigl`/`\bigr`, … |
+| `iP` `aP` | Section: `iP` is the body, `aP` includes the heading. Runs to the next heading of the same or higher level, or to `\end{document}` |
+| `im` `am` | `\item` in `itemize`, `enumerate` or `description`: `im` is the text after `\item[…]`, `am` includes `\item` |
+
+They act on the **innermost** object around the cursor. When the opening and
+closing tokens each sit on their own line, `ie`, `i$` (display math) and `am`
+work on whole lines.
+
+### Example
+
+With the cursor anywhere inside:
+
+```latex
+\begin{itemize}
+  \item one
+  \item two
+\end{itemize}
+```
+
+| Keys | Result |
+| --- | --- |
+| `die` | Deletes both `\item` lines, keeps `\begin`/`\end` |
+| `dae` | Deletes the whole environment |
+| `cie` | Empties the environment and enters insert mode |
+| `yae` | Copies the environment (paste with `p`) |
+| `vie` | Selects the contents, so you can see what `ie` covers |
+| `dam` | Deletes the item under the cursor |
+| `cim` | Rewrites the item's text |
+
+More: `ci$` rewrites an equation, `dac` deletes `\textbf{word}`, `cic` changes
+just `word`, `yaP` copies a whole section.
+
+Typing `ie` in normal mode *without* an operator starts insert mode and types
+`e`, because `i` means insert there.
+
+## Motions
+
+All motions take a count (`3]]`) and can follow an operator (`d]]`). Jumps are
+added to the jump list, so `Ctrl-o` takes you back.
+
+| Keys | Moves to |
+| --- | --- |
+| `]]` `[[` | Next / previous section start |
+| `][` `[]` | Next / previous section end |
+| `]m` `[m` | Next / previous `\begin{…}` |
+| `]M` `[M` | Next / previous `\end{…}` |
+| `]n` `[n` | Next / previous math start |
+| `]N` `[N` | Next / previous math end |
+| `]r` `[r` | Next / previous `\begin{frame}` (Beamer) |
+| `]R` `[R` | Next / previous `\end{frame}` |
+| `]*` | Next comment end |
+| `[*` | Previous comment start |
+| `%` | Matching `\begin` ↔ `\end`, `$` ↔ `$`, `\(` ↔ `\)`, `\[` ↔ `\]`, or bracket |
+
+Comments on consecutive lines count as one block for `]*` and `[*`.
+
+## Delete, change and toggle surroundings
+
+Put the cursor anywhere inside the thing, then type the keys in normal mode.
+
+| Keys | Environment | Command | Math | Delimiters |
+| --- | --- | --- | --- | --- |
+| `ds…` delete | `dse` | `dsc` | `ds$` | `dsd` |
+| `cs…` change | `cse` | `csc` | `cs$` | `csd` |
+| `ts…` toggle | `tse` / `tss` | `tsc` | `ts$` | `tsd` |
+
+- **`dse`** removes `\begin{…}`/`\end{…}` and keeps the contents. If a token
+  was alone on its line, the line goes too.
+- **`dsc`** replaces `\cmd[…]{text}` with `text`.
+- **`ds$`** removes the math delimiters or math environment.
+- **`dsd`** removes a bracket pair, including `\left`/`\right`.
+- **`cse`**, **`csc`** ask for a new name.
+- **`cs$`** asks for the new math form: `$`, `\(`, `\[`, `$$`, or an
+  environment name such as `align`.
+- **`csd`** asks for the new opening delimiter: `(`, `[`, `{`, `\{`, `|`, `\|`,
+  `\langle`, `\lvert` or `\lVert`. `\left`/`\right` are kept.
+- **`tse`** switches to the complementary environment: `itemize` ↔
+  `enumerate`, `equation` ↔ `align` (a star is kept). For any other
+  environment it asks for a name.
+- **`tss`** toggles the environment's star: `equation` ↔ `equation*`.
+- **`tsc`** toggles the command's star: `\section` ↔ `\section*`.
+- **`ts$`** toggles inline math (`$…$`, `\(…\)`) ↔ display math (`\[…\]`).
+- **`tsd`** toggles `(…)` ↔ `\left(…\right)`.
+
+### Other toggles
+
+| Keys | Does |
+| --- | --- |
+| `tsf` | `\frac{a}{b}` ↔ `a/b` (also `\dfrac`, `\tfrac`). Parentheses are added or removed as needed: `\frac{a+b}{c}` ↔ `(a+b)/c` |
+| `tsb` | Adds or removes a trailing `\\` on the current line, ignoring any `%` comment |
+
+## Leader commands
+
+| Keys | Does |
+| --- | --- |
+| `\ll` | Compile |
+| `\lv` | Show the cursor position in the PDF (SyncTeX) |
+| `\lt` | Toggle the outline |
+| `\le` | Show compile errors |
+
+## Insert mode
+
+| Keys | Does |
+| --- | --- |
+| `]]` | Closes the innermost open environment: typing `]]` after `\begin{align}…` inserts `\end{align}` |
+
+## Ex commands
+
+| Command | Does |
+| --- | --- |
+| `:w`, `:up` | Save |
+| `:VimtexCompile` | Compile |
+| `:VimtexView` | Show the cursor position in the PDF |
+| `:VimtexToc` | Toggle the outline |
+| `:VimtexErrors` | Show compile errors |
+
+The `:Vimtex…` ex commands work from any file, not only TeX files.
+
+## Standard Vim (every file)
+
+Everything monaco-vim supports works in every file, TeX or not:
+
+- **Modes:** `i a I A o O gi`, visual `v V Ctrl-v gv`, replace `R`, back to
+  normal with `Esc`, `Ctrl-[` or `Ctrl-c`.
+- **Moving:** `h j k l gj gk`, `w W b B e E ge gE`, `0 ^ $`, `f F t T` + char
+  with `;` `,`, `{ }` paragraphs, `( )` sentences, `gg G`, `H M L`,
+  `Ctrl-d Ctrl-u Ctrl-f Ctrl-b`, `zz zt zb`, marks `ma` / `` `a `` / `'a`,
+  jump list `Ctrl-o Ctrl-i`.
+- **Editing:** operators `d c y > < = gu gU g~`, plus `x X D C Y s S J gJ r ~
+  p P u Ctrl-r . Ctrl-a Ctrl-x`, and counts (`3dd`).
+- **Text objects:** `iw aw iW aW ip ap`, brackets `i( i[ i{ i<` (`ib` = `i(`,
+  `iB` = `i{`), quotes ``i" i' i` ``, tags `it at`.
+- **Search:** `/ ? n N * # gn gN`.
+- **Macros and registers:** `qa … q`, `@a`, `@@`, `"ayy`, `"ap`.
+- **Ex:** `:s` / `:%s`, `:g` / `:v`, `:sort`, `:noh`, `:set`, `:map` / `:nmap` /
+  `:imap` / `:vmap` / `:unmap`, `:registers`, `:delmarks`.
+
+Outside TeX files, `%`, `[[`, `]]`, `[m`, `]m`, `[*`, `]*` and the `i…`/`a…`
+text objects above fall back to plain Vim. The Vim versions of `[[`, `]m` and
+`[*` look for C-style code structure and aren't much use in Markdown.
+
+## Notes
+
+- The `ts…` commands start with `t`, so Vim's "move to just before the letter
+  s" (`ts`, then another key) runs as soon as you type the third key, as in
+  VimTeX.
+- The VimTeX `ds…`, `cs…` and `ts…` commands only start from a fresh normal
+  mode: not after a count (`2dse` does nothing special) and not in visual mode.
+- Every `ds…`, `cs…` and `ts…` edit is a single undo step.

{gitlatex-1.10.0 → gitlatex-2.0.0}/gitlatex/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '1.10.0'
-__version_tuple__ = version_tuple = (1, 10, 0)
+__version__ = version = '2.0.0'
+__version_tuple__ = version_tuple = (2, 0, 0)
 
-__commit_id__ = commit_id = 'gf35199fa5'
+__commit_id__ = commit_id = 'gf67d4da27'

{gitlatex-1.10.0 → gitlatex-2.0.0}/gitlatex/app.py

@@ -25,7 +25,10 @@ def create_app(repos_dir=None):
     app = Flask(__name__, static_folder=None)
     app.config["MAX_CONTENT_LENGTH"] = 50 * 1024 * 1024  # 50MB
 
-    state.BASE_DIR = str(Path(repos_dir) if repos_dir else _repos_base())
+    # Absolute, because Flask's send_file resolves relative paths against the
+    # package folder rather than the working directory (`--repos repos` broke
+    # every file download).
+    state.BASE_DIR = os.path.abspath(str(Path(repos_dir) if repos_dir else _repos_base()))
     os.makedirs(state.BASE_DIR, exist_ok=True)
 
     public = paths._public_dir()