Metadata-Version: 2.4
Name: summit-md
Version: 0.1.0
Summary: A terminal Markdown browser with native Mermaid rendering, based on Hike
Keywords: terminal,tui,chui,documentation,markdown,markdown-viewer,file-viewer,file-browser,mermaid
Author: Dave Pearson, W4N2
Author-email: Dave Pearson <davep@davep.org>
License-Expression: GPL-3.0-or-later
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Other Audience
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows :: Windows 10
Classifier: Operating System :: Microsoft :: Windows :: Windows 11
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Terminals
Classifier: Topic :: Text Processing :: Markup :: Markdown
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Requires-Dist: textual>=5.3.0
Requires-Dist: textual-enhanced>=0.13.0
Requires-Dist: textual-fspicker>=0.4.1
Requires-Dist: xdg-base-dirs>=6.0.2
Requires-Dist: httpx>=0.28.1
Requires-Dist: typing-extensions>=4.12.2
Requires-Dist: pyperclip>=1.9.0
Requires-Dist: termaid[rich]>=0.8.0
Requires-Python: >=3.10
Project-URL: Documentation, https://github.com/W4N2/summit#readme
Project-URL: Homepage, https://github.com/W4N2/summit
Project-URL: Issues, https://github.com/W4N2/summit/issues
Project-URL: Repository, https://github.com/W4N2/summit
Project-URL: Source, https://github.com/W4N2/summit
Description-Content-Type: text/markdown

# Summit

A terminal Markdown browser with **native Mermaid diagram rendering**, based on [Hike](https://github.com/davep/hike) by Dave Pearson.

Install the **`summit-md`** package, run the **`summit`** command.

## Install

### uv (recommended)

```sh
uv tool install summit-md
```

Or run once without installing:

```sh
uvx summit-md README.md
```

From a local checkout:

```sh
git clone https://github.com/W4N2/summit.git
cd summit
uv sync
uv tool install .
```

### pipx

```sh
pipx install summit-md
```

### pip

```sh
pip install summit-md
```

## Usage

```sh
summit README.md
summit docs/architecture.md
summit gh textualize/textual
```

Press <kbd>F1</kbd> inside the app for help, or <kbd>ctrl</kbd>+<kbd>p</kbd> 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** — ` ```mermaid ` blocks render as terminal diagrams (via [termaid](https://github.com/fasouto/termaid))
- **ERDs and conceptual models** — `erDiagram` blocks 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:

```json
{
    "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](LICENSE).

Summit is a fork of [Hike](https://github.com/davep/hike). Hike is Copyright (C) 2025 Dave Pearson.

## Links

- [Repository](https://github.com/W4N2/summit)
- [Upstream Hike](https://github.com/davep/hike)
- [Issues](https://github.com/W4N2/summit/issues)
