โ† All libraries

SugarGlow

๐Ÿ“– SugarGlow

Markdown CLI viewer + pager

port of glow markdown viewer pager

Composes CandyShine (rendering) and SugarBits Viewport (scrolling). Render to stdout or open in a fullscreen pager. All eight CandyShine themes plus custom JSON.

Install

composer require candycore/sugar-glow

Quickstart

sugarglow README.md                   # render to stdout (default)
sugarglow -p README.md                # open in a fullscreen pager
git log -1 --pretty=%B | sugarglow -p # pipe stdin
sugarglow --theme dracula README.md
sugarglow --width 80 --no-hyperlinks README.md
sugarglow --theme-config ./my-theme.json README.md

What's in the box

Stdout modesugarglow README.md โ€” pipe-friendly, exits clean.
Pager mode-p / --pager โ€” fullscreen scrollable Viewport. Esc / q to exit.
Theme picker--theme dracula, --theme-config ./my.json, -s alias for glamour-compat.
Word-wrap-w 80 โ€” column width control. 0 disables.
OSC 8 toggle--no-hyperlinks falls back to text (url) rendering.
Stdin supportgit log -1 --pretty=%B | sugarglow -p.

Source & demos

Try the quickstart โ†’

Demos.

VHS-recorded GIFs of every example shipped with the library. Regenerated automatically on every push that touches the source.

Render

Render

README rendered through four themes โ€” ansi / dark / dracula / pink.