Summit
A terminal Markdown browser with native Mermaid diagram rendering, based on Hike by Dave Pearson.
Install the summit-md package, run the summit command.
Install
uv (recommended)
uv tool install summit-md
Or run once without installing:
uvx summit-md README.md
From a local checkout:
git clone https://github.com/W4N2/summit.git
cd summit
uv sync
uv tool install .
pipx
pipx install summit-md
pip
pip install summit-md
Usage
summit README.md
summit docs/architecture.md
summit gh textualize/textual
Press F1 inside the app for help, or ctrl+p for the command palette.
What's different from Hike
Summit keeps everything Hike does — local file browsing, forge shortcuts, bookmarks, history, wiki links, editing — and adds:
- Native Mermaid rendering —
```mermaidblocks render as terminal diagrams (via termaid) - ERDs and conceptual models —
erDiagramblocks use schema-style entity cards, crow's-foot notation, and Chen diamonds when attributes are omitted - Configurable — toggle rendering and pick a diagram theme in
~/.config/summit/configuration.json
Example configuration:
{
"render_mermaid": true,
"mermaid_theme": "default"
}
Available Mermaid themes: default, terra, neon, mono, amber, phosphor.
File locations
Summit stores data under ~/.config/summit/ and ~/.local/share/summit/ (separate from Hike's directories).
License
GPL-3.0-or-later — same as Hike. See LICENSE.
Summit is a fork of Hike. Hike is Copyright (C) 2025 Dave Pearson.
Links
1 maintainer
Metadata
1 maintainer
Release files for summit-md 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| summit_md-0.1.0.tar.gz | 52.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| summit_md-0.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 125.4 kB
Release files / summit_md-0.1.0.tar.gz
| Download URL | summit_md-0.1.0.tar.gz |
|---|---|
| Size | 52.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b500fe2e1a835a2da191cfb01835122712cf1a3cccdebd092ae096a7ace0814f
|
|
BLAKE2b-256 checksum How to use checksums |
1e6984a08df246f380d033ccf4c7108e4d28f7b4842b5b0d142f7714b336b391
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Release files / summit_md-0.1.0-py3-none-any.whl
| Download URL | summit_md-0.1.0-py3-none-any.whl |
|---|---|
| Size | 73.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
97aba8ce1fef7c9c3ffb26b4cb176b96dd5ad9d2aa12ae53af5ec1450f0e88f2
|
|
BLAKE2b-256 checksum How to use checksums |
80f771bd003c6052155d806b8f566cb21ac6d80dda025d1d713dd5c26a6f34b0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
