dvm-mdview 0.1.0__tar.gz

dvm_mdview-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python: ["3.10", "3.13"]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # the version is derived from git tags
+      - uses: astral-sh/setup-uv@v6
+        with:
+          python-version: ${{ matrix.python }}
+      - run: uv sync
+      - run: uv run pytest -q
+      - run: uv build
+      - name: Run the built wheel the way uvx does
+        shell: bash
+        run: uvx --from dist/*.whl dvm-mdview --version

dvm_mdview-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,56 @@
+name: Release
+
+# Pushing a tag such as v1.2.3 builds version 1.2.3 (the version is derived
+# from the tag), creates the GitHub release and uploads to PyPI.
+#
+# PyPI upload uses "trusted publishing": on pypi.org add this repository,
+# workflow "publish.yml" and environment "pypi" as a trusted publisher for
+# the project dvm-mdview. No API token is stored.
+on:
+  push:
+    tags: ["v*"]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: astral-sh/setup-uv@v6
+      - run: uv build
+      - name: Check that the built version matches the tag
+        run: ls "dist/dvm_mdview-${GITHUB_REF_NAME#v}-py3-none-any.whl" "dist/dvm_mdview-${GITHUB_REF_NAME#v}.tar.gz"
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+          if-no-files-found: error
+
+  github-release:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - run: gh release create "$GITHUB_REF_NAME" dist/* --repo "$GITHUB_REPOSITORY" --title "$GITHUB_REF_NAME" --generate-notes --verify-tag
+        env:
+          GH_TOKEN: ${{ github.token }}
+
+  pypi:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: astral-sh/setup-uv@v6
+      - run: uv publish

dvm_mdview-0.1.0/.gitignore

@@ -0,0 +1,8 @@
+__pycache__/
+*.pyc
+.venv/
+dist/
+build/
+*.egg-info/
+.pytest_cache/
+src/mdview/_version.py

dvm_mdview-0.1.0/AGENTS.md

@@ -0,0 +1,43 @@
+# mdview
+
+Markdown viewer and editor with live preview. One Python package (`dvm-mdview` on PyPI, import
+name `mdview`) with a graphical UI and a terminal UI that share one renderer.
+
+## Rules that always apply
+
+1. **No mention of Claude, Anthropic, AI or AI assistance** in commit messages (including trailers),
+   pull request or issue text, comments, or any file. Only `AGENTS.md`, `CLAUDE.md` and
+   `docs/dev/git.md` may mention it, because they state the rule.
+2. **Commit as the repository owner**, never under a tool or bot identity. Set author and committer
+   on every commit; the exact commands are in `docs/dev/git.md`.
+3. **Must run on macOS and Windows through `uvx`.** Pure Python only, no build step, no new
+   dependency without wheels for both.
+
+## Everyday commands
+
+```bash
+uv sync
+```
+
+```bash
+uv run pytest -q
+```
+
+```bash
+uv run mdview --browser README.md
+```
+
+```bash
+uv run mdview --tui README.md
+```
+
+## Read more only when the task needs it
+
+| If you are about to... | Read |
+|---|---|
+| commit, push, or write a pull request | `docs/dev/git.md` |
+| change rendering, the backend, or either UI | `docs/dev/architecture.md` |
+| add or debug tests, or check a UI change by hand | `docs/dev/testing.md` |
+| cut a release or update the bundled Mermaid / KaTeX | `docs/dev/releasing.md` |
+
+User-facing behaviour, options and keys are documented in `README.md`; keep it in step with changes.

dvm_mdview-0.1.0/CLAUDE.md

@@ -0,0 +1 @@
+@AGENTS.md

dvm_mdview-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 divyavanmahajan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

dvm_mdview-0.1.0/PKG-INFO

@@ -0,0 +1,170 @@
+Metadata-Version: 2.5
+Name: dvm-mdview
+Version: 0.1.0
+Summary: Markdown viewer and live-preview editor with a graphical UI and a terminal UI
+Project-URL: Homepage, https://github.com/divyavanmahajan/mdview
+Project-URL: Issues, https://github.com/divyavanmahajan/mdview/issues
+License-Expression: MIT
+License-File: LICENSE
+License-File: src/mdview/web/vendor/LICENSE-katex
+License-File: src/mdview/web/vendor/LICENSE-mermaid
+Keywords: editor,gui,markdown,preview,tui,viewer
+Classifier: Environment :: Console
+Classifier: Environment :: MacOS X
+Classifier: Environment :: Win32 (MS Windows)
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Text Editors
+Classifier: Topic :: Text Processing :: Markup :: Markdown
+Requires-Python: >=3.10
+Requires-Dist: linkify-it-py>=2.0
+Requires-Dist: markdown-it-py>=3.0
+Requires-Dist: mdit-py-plugins>=0.4.1
+Requires-Dist: pygments>=2.17
+Requires-Dist: pywebview>=5.3
+Requires-Dist: textual>=3.0
+Description-Content-Type: text/markdown
+
+# mdview
+
+A Markdown viewer and editor with live preview, for macOS, Windows and Linux.
+It has two interfaces that share one renderer:
+
+- a **graphical UI** in a native window, and
+- a **terminal UI** for use in a shell or over SSH.
+
+Published on PyPI as **`dvm-mdview`**.
+
+## Run it
+
+With [uv](https://docs.astral.sh/uv/) installed, nothing else needs installing:
+
+```bash
+uvx dvm-mdview README.md
+```
+
+```bash
+uvx dvm-mdview --tui README.md
+```
+
+Or install it, which gives you the shorter `mdview` command:
+
+```bash
+uv tool install dvm-mdview
+```
+
+```bash
+mdview notes.md
+```
+
+| Option | Effect |
+|---|---|
+| *(none)* | Graphical UI. Falls back to the terminal UI when there is no display. |
+| `-t`, `--tui` | Terminal UI. |
+| `-b`, `--browser` | Graphical UI in your default browser instead of a native window. |
+| `-e`, `--edit` | Start with editor and preview side by side. |
+| `-r`, `--read` | Start with the preview only. |
+
+A file that does not exist yet is opened empty and created when you save.
+Passing a folder opens its `README.md`.
+
+## Features
+
+- **Live preview.** View, Split (editor and preview side by side) and Edit layouts. The preview
+  updates as you type.
+- **Link navigation.** Links to other Markdown files open in place, with back and forward history.
+  Links to headings scroll to them. Web links open in your browser. A link to a file that does not
+  exist starts a new document at that path.
+- **Markdown.** CommonMark with GitHub tables, task lists, strikethrough and autolinks, plus
+  footnotes, YAML front matter and heading anchors.
+- **Code highlighting** in both interfaces.
+- **Mermaid diagrams and LaTeX math** rendered in the graphical UI (shown as source in the terminal).
+  Both work offline; the libraries are bundled.
+- **Safe saving.** Files are written atomically, you are asked before unsaved changes are lost, and
+  a file changed by another program is reloaded (or flagged, if you have edits of your own).
+- Outline sidebar, light and dark themes, and relative images in the graphical UI.
+
+## Keys
+
+### Graphical UI
+
+`Cmd` replaces `Ctrl` on macOS.
+
+| Key | Action |
+|---|---|
+| `Ctrl+E` | Cycle View / Split / Edit |
+| `Ctrl+S`, `Ctrl+Shift+S` | Save, Save as |
+| `Ctrl+O`, `Ctrl+N` | Open, New |
+| `Alt+Left`, `Alt+Right` | Back, Forward |
+| `Ctrl+B`, `Ctrl+I`, `Ctrl+K` | Bold, italic, link |
+
+### Terminal UI
+
+| Key | Action |
+|---|---|
+| `Ctrl+E` | Cycle View / Split / Edit |
+| `F6` | Switch between editor and preview |
+| `Ctrl+S` | Save |
+| `Ctrl+O` | Open |
+| `Ctrl+L` | List the document's links and follow one |
+| `Alt+Left`, `Alt+Right` | Back, Forward |
+| `Ctrl+P` | Command palette (Save as, New, theme, ...) |
+| `Ctrl+Q` | Quit |
+
+Links can also be clicked with the mouse. While the preview has focus, single keys work too:
+`e` edit, `l` links, `o` open, `b` back, `f` forward, `j`/`k` scroll, `q` quit.
+
+## How it is built
+
+| Part | Library |
+|---|---|
+| Markdown parsing | [markdown-it-py](https://github.com/executablebooks/markdown-it-py) and [mdit-py-plugins](https://github.com/executablebooks/mdit-py-plugins) |
+| Code highlighting | [Pygments](https://pygments.org/) |
+| Native window | [pywebview](https://pywebview.flowrl.com/) (WebKit on macOS, WebView2 on Windows) |
+| Terminal UI | [Textual](https://textual.textualize.io/) |
+| Diagrams and math | [Mermaid](https://mermaid.js.org/) and [KaTeX](https://katex.org/), bundled |
+
+The graphical UI is a small web app served by a local backend (`src/mdview/server.py`) that listens
+only on `127.0.0.1` and requires a per-run secret token. Raw HTML in a document is displayed, but a
+strict Content-Security-Policy stops any script in it from running.
+
+On Linux a native window needs GTK or Qt bindings for pywebview; without them mdview uses the
+browser automatically.
+
+## Development
+
+```bash
+uv sync
+```
+
+```bash
+uv run pytest
+```
+
+```bash
+uv run mdview README.md
+```
+
+### Releasing
+
+The version comes from the git tag, so the tag and the PyPI version always match.
+
+1. Once, on pypi.org, add this repository as a *trusted publisher* for `dvm-mdview`
+   (workflow `publish.yml`, environment `pypi`).
+2. Tag a commit on `main` and push the tag:
+
+```bash
+git tag v1.2.3
+```
+
+```bash
+git push origin v1.2.3
+```
+
+The `Release` workflow builds version 1.2.3, creates the GitHub release and uploads to PyPI.
+
+## License
+
+MIT. Bundled Mermaid and KaTeX are MIT licensed; their licences are in `src/mdview/web/vendor/`.

dvm_mdview-0.1.0/README.md

@@ -0,0 +1,141 @@
+# mdview
+
+A Markdown viewer and editor with live preview, for macOS, Windows and Linux.
+It has two interfaces that share one renderer:
+
+- a **graphical UI** in a native window, and
+- a **terminal UI** for use in a shell or over SSH.
+
+Published on PyPI as **`dvm-mdview`**.
+
+## Run it
+
+With [uv](https://docs.astral.sh/uv/) installed, nothing else needs installing:
+
+```bash
+uvx dvm-mdview README.md
+```
+
+```bash
+uvx dvm-mdview --tui README.md
+```
+
+Or install it, which gives you the shorter `mdview` command:
+
+```bash
+uv tool install dvm-mdview
+```
+
+```bash
+mdview notes.md
+```
+
+| Option | Effect |
+|---|---|
+| *(none)* | Graphical UI. Falls back to the terminal UI when there is no display. |
+| `-t`, `--tui` | Terminal UI. |
+| `-b`, `--browser` | Graphical UI in your default browser instead of a native window. |
+| `-e`, `--edit` | Start with editor and preview side by side. |
+| `-r`, `--read` | Start with the preview only. |
+
+A file that does not exist yet is opened empty and created when you save.
+Passing a folder opens its `README.md`.
+
+## Features
+
+- **Live preview.** View, Split (editor and preview side by side) and Edit layouts. The preview
+  updates as you type.
+- **Link navigation.** Links to other Markdown files open in place, with back and forward history.
+  Links to headings scroll to them. Web links open in your browser. A link to a file that does not
+  exist starts a new document at that path.
+- **Markdown.** CommonMark with GitHub tables, task lists, strikethrough and autolinks, plus
+  footnotes, YAML front matter and heading anchors.
+- **Code highlighting** in both interfaces.
+- **Mermaid diagrams and LaTeX math** rendered in the graphical UI (shown as source in the terminal).
+  Both work offline; the libraries are bundled.
+- **Safe saving.** Files are written atomically, you are asked before unsaved changes are lost, and
+  a file changed by another program is reloaded (or flagged, if you have edits of your own).
+- Outline sidebar, light and dark themes, and relative images in the graphical UI.
+
+## Keys
+
+### Graphical UI
+
+`Cmd` replaces `Ctrl` on macOS.
+
+| Key | Action |
+|---|---|
+| `Ctrl+E` | Cycle View / Split / Edit |
+| `Ctrl+S`, `Ctrl+Shift+S` | Save, Save as |
+| `Ctrl+O`, `Ctrl+N` | Open, New |
+| `Alt+Left`, `Alt+Right` | Back, Forward |
+| `Ctrl+B`, `Ctrl+I`, `Ctrl+K` | Bold, italic, link |
+
+### Terminal UI
+
+| Key | Action |
+|---|---|
+| `Ctrl+E` | Cycle View / Split / Edit |
+| `F6` | Switch between editor and preview |
+| `Ctrl+S` | Save |
+| `Ctrl+O` | Open |
+| `Ctrl+L` | List the document's links and follow one |
+| `Alt+Left`, `Alt+Right` | Back, Forward |
+| `Ctrl+P` | Command palette (Save as, New, theme, ...) |
+| `Ctrl+Q` | Quit |
+
+Links can also be clicked with the mouse. While the preview has focus, single keys work too:
+`e` edit, `l` links, `o` open, `b` back, `f` forward, `j`/`k` scroll, `q` quit.
+
+## How it is built
+
+| Part | Library |
+|---|---|
+| Markdown parsing | [markdown-it-py](https://github.com/executablebooks/markdown-it-py) and [mdit-py-plugins](https://github.com/executablebooks/mdit-py-plugins) |
+| Code highlighting | [Pygments](https://pygments.org/) |
+| Native window | [pywebview](https://pywebview.flowrl.com/) (WebKit on macOS, WebView2 on Windows) |
+| Terminal UI | [Textual](https://textual.textualize.io/) |
+| Diagrams and math | [Mermaid](https://mermaid.js.org/) and [KaTeX](https://katex.org/), bundled |
+
+The graphical UI is a small web app served by a local backend (`src/mdview/server.py`) that listens
+only on `127.0.0.1` and requires a per-run secret token. Raw HTML in a document is displayed, but a
+strict Content-Security-Policy stops any script in it from running.
+
+On Linux a native window needs GTK or Qt bindings for pywebview; without them mdview uses the
+browser automatically.
+
+## Development
+
+```bash
+uv sync
+```
+
+```bash
+uv run pytest
+```
+
+```bash
+uv run mdview README.md
+```
+
+### Releasing
+
+The version comes from the git tag, so the tag and the PyPI version always match.
+
+1. Once, on pypi.org, add this repository as a *trusted publisher* for `dvm-mdview`
+   (workflow `publish.yml`, environment `pypi`).
+2. Tag a commit on `main` and push the tag:
+
+```bash
+git tag v1.2.3
+```
+
+```bash
+git push origin v1.2.3
+```
+
+The `Release` workflow builds version 1.2.3, creates the GitHub release and uploads to PyPI.
+
+## License
+
+MIT. Bundled Mermaid and KaTeX are MIT licensed; their licences are in `src/mdview/web/vendor/`.

dvm_mdview-0.1.0/docs/dev/architecture.md

@@ -0,0 +1,45 @@
+# Architecture
+
+All code is in `src/mdview/`.
+
+| File | Role |
+|---|---|
+| `cli.py` | Argument parsing; picks terminal UI, native window or browser. |
+| `render.py` | Everything both UIs share: Markdown to HTML, link resolution, link extraction, reading and atomic writing of files. |
+| `server.py` | Loopback HTTP backend for the graphical UI. |
+| `gui.py` | Hosts the web app in a pywebview window, or the default browser as fallback. |
+| `tui.py` | Textual app. |
+| `web/` | The graphical UI: `index.html`, `app.js`, `app.css`, and `vendor/` (bundled Mermaid and KaTeX). |
+
+## Rendering
+
+- `render.py` builds one markdown-it-py parser (`gfm-like` preset plus front matter, footnotes,
+  task lists, anchors, dollar math). Pygments highlights fenced code in Python.
+- Mermaid fences become `<pre class="mermaid">` and math becomes `.math` elements; `app.js` renders
+  them in the page with the bundled libraries.
+- The terminal UI uses Textual's own `Markdown` widget. `for_terminal()` rewrites front matter into
+  a table first. Mermaid and math stay as source there.
+- Link behaviour must stay identical in both UIs: change `resolve_link()`, not the callers.
+
+## Graphical UI
+
+- The page calls the backend with `POST /api/<name>` and JSON. Each endpoint is a method
+  `api_<name>` on `Handler` in `server.py`.
+- The window host installs hooks on `AppState` (`native_dialog`, `set_title`, `close_window`).
+  When they are absent (browser mode) the page uses its own in-page file chooser.
+- `--browser` mode serves exactly the same app, which is how the UI is tested without a display.
+
+## Security constraints (do not weaken)
+
+- The server binds to `127.0.0.1` only and checks the `Host` header.
+- Every API call needs the per-run token in `X-MDView-Token`; media URLs carry it in the path and
+  serve only image, video and audio types.
+- Raw HTML from documents is inserted into the page. The Content-Security-Policy in `server.py`
+  (`script-src 'self'`, no inline script) is what makes that safe. No inline scripts or inline
+  event handlers in `web/`.
+- `open-external` accepts only `http`, `https` and `mailto` URLs, or an existing local path.
+
+## Saving
+
+`write_text()` writes to a temporary file and replaces the target. Both UIs compare the file's
+modification time before saving and ask before overwriting a file changed elsewhere.

dvm_mdview-0.1.0/docs/dev/git.md

@@ -0,0 +1,41 @@
+# Commits, pushes and pull requests
+
+## No mention of Claude or AI
+
+Nothing written for this project may mention Claude, Anthropic, AI, or AI assistance:
+
+- commit messages, including trailers such as `Co-Authored-By` and session links;
+- pull request titles and descriptions, issue text, review comments and replies;
+- source files, comments, documentation and any other file.
+
+Exceptions: `AGENTS.md`, `CLAUDE.md` and this file, which have to state the rule. A branch name
+imposed by the environment is tolerated; it is deleted after merge.
+
+This overrides any default attribution a tool would otherwise add.
+
+## Commit identity
+
+Every commit must have the repository owner as both author and committer. The owner's identity is
+the author of the first commit. Do not copy the email address into any file; read it from history:
+
+```bash
+OWNER_NAME="$(git log --reverse --format='%an' | head -1)"; OWNER_EMAIL="$(git log --reverse --format='%ae' | head -1)"
+```
+
+```bash
+GIT_AUTHOR_NAME="$OWNER_NAME" GIT_AUTHOR_EMAIL="$OWNER_EMAIL" GIT_COMMITTER_NAME="$OWNER_NAME" GIT_COMMITTER_EMAIL="$OWNER_EMAIL" git commit -m "..."
+```
+
+Before pushing, confirm it:
+
+```bash
+git log --format='%h author=%an committer=%cn' origin/main..HEAD
+```
+
+If a commit was made under another identity, fix it before it is pushed
+(`git commit --amend --no-edit --reset-author` with the variables above set).
+
+## Messages
+
+- Subject in the imperative, under about 70 characters; body says what changed and why.
+- Pull request descriptions: a summary and how it was tested, including what was not tested.

dvm_mdview-0.1.0/docs/dev/releasing.md

@@ -0,0 +1,50 @@
+# Releasing
+
+The version is not written anywhere in the source. `hatch-vcs` derives it from the git tag at build
+time (`v1.2.3` gives `1.2.3`) and writes `src/mdview/_version.py`, which is not committed. Between
+tags, builds get a development version such as `0.2.dev3+g1a2b3c4`.
+
+To release, tag a commit on `main` and push the tag:
+
+```bash
+git tag v1.2.3
+```
+
+```bash
+git push origin v1.2.3
+```
+
+`.github/workflows/publish.yml` then builds, checks that the built version equals the tag, creates
+the GitHub release with the built files attached, and uploads to PyPI through trusted publishing
+(project `dvm-mdview`, workflow `publish.yml`, environment `pypi`; configured once on pypi.org).
+The GitHub release and the PyPI upload are separate jobs, so one can be re-run without the other.
+
+Do not create the release by hand in the GitHub UI; the workflow would then fail to create it.
+
+To check a build locally:
+
+```bash
+uv build
+```
+
+```bash
+uvx --from dist/*.whl dvm-mdview --version
+```
+
+Builds need git history and tags; in CI, check out with `fetch-depth: 0`.
+
+The wheel must contain `mdview/web/` including `vendor/`; `uv build` output can be checked with
+`python -m zipfile -l dist/*.whl`.
+
+## Updating bundled Mermaid and KaTeX
+
+Currently Mermaid 12.3.0 and KaTeX 0.19.1. They are copied from the npm packages, not built:
+
+```bash
+npm pack mermaid katex
+```
+
+From the unpacked packages copy `mermaid/dist/mermaid.min.js`, `katex/dist/katex.min.js`,
+`katex/dist/katex.min.css`, `katex/dist/fonts/*.woff2` and both `LICENSE` files into
+`src/mdview/web/vendor/` (licences as `LICENSE-mermaid` and `LICENSE-katex`). Update the versions
+above, then check a Mermaid block and a math block in the graphical UI.

dvm_mdview-0.1.0/docs/dev/testing.md

@@ -0,0 +1,35 @@
+# Testing
+
+```bash
+uv run pytest -q
+```
+
+| File | Covers |
+|---|---|
+| `tests/test_render.py` | Rendering features, slugs, link resolution, file reading and writing. |
+| `tests/test_server.py` | Backend endpoints, token and host checks, save conflicts, media serving. |
+| `tests/test_tui.py` | Terminal UI through Textual's pilot. |
+
+## Terminal UI tests
+
+Actions that open a dialog run in a worker that waits for the dialog. Do not call
+`app.workers.wait_for_complete()` while a dialog is open; it never returns. Use `pilot.pause()`,
+then act on the dialog.
+
+## Checking the graphical UI
+
+There are no automated browser tests in the repository. To check a change, run the app in browser
+mode and drive it with a browser (by hand or with Playwright):
+
+```bash
+uv run mdview --browser --no-open --port 8765 README.md
+```
+
+Wait for `body[data-ready]` before interacting. Check at least: live preview while typing, a link to
+another file and back, an anchor link, save, and a Mermaid block and a math block.
+
+## What cannot be tested on Linux without a display
+
+The native pywebview window, native file dialogs, and the close prompt with unsaved changes. These
+need a manual check on macOS and Windows. CI runs the test suite on all three systems but does not
+open a window.