📖 SugarGlow
Markdown CLI viewer + pager
Composes CandyShine (rendering) and SugarBits Viewport (scrolling). Render to stdout or open in a fullscreen pager. Eleven built-in themes (ansi, plain, dark, light, notty, dracula, tokyo-night, pink, solarized, monokai, github) plus custom JSON.
Install
composer require sugarcraft/sugar-glowQuickstart
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.mdWhat's in the box
Stdout mode
sugarglow README.md — pipe-friendly, exits clean.Pager mode
-p / --pager — fullscreen scrollable Viewport. Esc / q to exit.Theme picker
--theme {ansi|plain|dark|light|notty|dracula|tokyo-night|pink|solarized|monokai|github}, --theme-config ./my.json, -s alias for glamour-compat. Three themes (solarized/monokai/github) load from JSON in themes/.Word-wrap
-w 80 — column width control. 0 disables.OSC 8 toggle
--no-hyperlinks falls back to text (url) rendering.Stdin support
git log -1 --pretty=%B | sugarglow -p.Source & demos
- Source on GitHub
- Full README
- Runnable examples
- Port of glow (Go upstream)
See also
- CandyShine — markdown renderer that powers SugarGlow
- SugarBits — Viewport component used for scrolling
API
| Class | Method | Description |
|---|---|---|
| GlamourTheme | fromJson(json) | Parse a Glamour theme JSON string |
| GlamourTheme | fromFile(path) | Load a Glamour theme from a JSON file |
| GlamourTheme | resolve(token) | Resolve a chroma token to its SGR color |
| FileWatcher | hasChangedSince(mtime) | Check if file modified since given mtime |
| FileWatcher | watch(path, intervalMs) | Generator watching a file for changes (mtime polling) |
| WidthHelper | visualWidth(text) | Visual width accounting for CJK/emoji |
| WidthHelper | padRight(text, width) | Pad string to fixed visual width |
| WidthHelper | slice(text, start, end) | Slice string by visual width offsets |
| WidthHelper | isFullWidth(char) | Check if character is full-width |
| WidthHelper | truncate(text, maxWidth) | Truncate string to max visual width |
