Vibeleaderboard
← Back to Tools
Index / tool

shine

github.com/nithish-yenaganti/shine
Visit github.com
Category
Developer Tools
Rank
No. 1204Tools index
Pricing
Open Source
Platform
cli
Type
TOOL
GitHub
2 stars
Latest release
v0.1.2
Date

About

A terminal-based Markdown previewer and docs linter that renders READMEs, changelogs, and release notes as a styled TUI with themes, search, and inline image/Mermaid support. It also includes a --check mode that flags common docs issues like broken links, missing alt text, and malformed heading structure before publishing.

What it can do

  • Render Markdown files (READMEs, changelogs, release notes) as a styled terminal UI

    Markdown file → Styled TUI preview

  • Search within rendered documentation

    Search query → Matched text locations

  • Display inline images and Mermaid diagrams within Markdown preview

    Markdown file with images/Mermaid code → Rendered images/diagrams in TUI

  • Check documentation for issues like broken links, missing alt text, and malformed heading structure

    Markdown file → List of docs issues

Why it made the leaderboard

Reviewing Markdown docs usually means leaving the terminal for a browser preview; Shine keeps that loop inside the shell with a real interactive TUI, useful for anyone maintaining READMEs and changelogs in a CLI-first workflow.

Tags

climarkdownterminaltuidocsgolanglinter

Tech Stack

Node.jsGo

Comments (0)

No comments yet

Editorially curated, with community endorsements as a secondary signal. Corrections welcome.