https://github.com/boolean-maybe/navidown
Navigable CLI Markdown renderer
https://github.com/boolean-maybe/navidown
Last synced: 29 days ago
JSON representation
Navigable CLI Markdown renderer
- Host: GitHub
- URL: https://github.com/boolean-maybe/navidown
- Owner: boolean-maybe
- License: apache-2.0
- Created: 2026-01-15T20:51:40.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2026-03-27T13:56:30.000Z (about 1 month ago)
- Last Synced: 2026-03-27T16:48:10.431Z (about 1 month ago)
- Language: Go
- Size: 323 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# navidown
## About
`navidown` is a reusable navigable markdown CLI component:
- renders markdown to **ANSI** (for terminal output)
- supports **scrolling** and **pager-style navigation**
- finds **links** and allows **Tab / Shift-Tab** traversal
- on activation (Enter), loads linked markdown via a pluggable loader and replaces current content
This repo contains:
- core package `github.com/boolean-maybe/navidown/navidown` (UI-agnostic state machine + renderers)
- optional TView adapter `github.com/boolean-maybe/navidown/navidown/tview` (TView primitive)
## Installation
```bash
go get github.com/boolean-maybe/navidown/navidown
```
For the TView adapter:
```bash
go get github.com/boolean-maybe/navidown/navidown/tview
```
For the file/HTTP content loader:
```bash
go get github.com/boolean-maybe/navidown/loaders
```
## Quick Start
### Using the TView Adapter
Two adapters are available: `BoxViewer` (custom draw) and `TextViewViewer` (TextView paging). This example uses `TextViewViewer`.
```go
package main
import (
"github.com/boolean-maybe/navidown/loaders"
nav "github.com/boolean-maybe/navidown/navidown"
navtview "github.com/boolean-maybe/navidown/navidown/tview"
"github.com/rivo/tview"
)
func main() {
app := tview.NewApplication()
viewer := navtview.NewTextView()
// Set initial markdown content
viewer.SetMarkdown(`# Welcome to navidown
Navigate through links with **Tab** and **Shift+Tab**.
Press **Enter** to follow links.
[Example Link](https://example.com)
[Local File](./README.md)
## Features
- ANSI terminal rendering
- Link navigation
- Scrolling support
`)
// Handle link activation
fetcher := nav.NewContentFetcher(&loaders.FileHTTP{}, nil)
viewer.SetSelectHandler(func(v *navtview.TextViewViewer, elem nav.NavElement) {
content, err := fetcher.FetchContent(elem)
if err == nil {
v.SetMarkdownWithSource(content, elem.URL, true)
}
})
if err := app.SetRoot(viewer, true).Run(); err != nil {
panic(err)
}
}
```
### Using the Core API (UI-agnostic)
```go
package main
import (
"fmt"
"github.com/boolean-maybe/navidown/navidown"
)
func main() {
session := navidown.New(navidown.Options{})
// Set markdown content
_ = session.SetMarkdown(`# Hello World
This is a [link](https://example.com).
## Section
More content here.`)
// Get rendered ANSI lines
lines := session.RenderedLines()
for _, line := range lines {
fmt.Println(line)
}
// Navigate through links
session.MoveToNextLink(20)
if selected := session.Selected(); selected != nil {
fmt.Printf("Selected: %s -> %s\n", selected.Text, selected.URL)
}
}
```
[](https://goreportcard.com/report/github.com/boolean-maybe/navidown)
[](https://pkg.go.dev/github.com/boolean-maybe/navidown)