🌟 CandyShine
Markdown → ANSI renderer
Built on league/commonmark + CandySprinkles. Word-wrap, OSC 8 hyperlinks, syntax highlighting, nine built-in themes plus custom JSON themes.
Install
composer require sugarcraft/candy-shineQuickstart
use SugarCraft\Shine\{Renderer, Theme};
echo (new Renderer())->render(<<<MD
# Welcome
A few **bold** and _italic_ words, with `inline code` and a
[link](https://example.com).
- one
- two
- three
```php
echo "hello world";
```
MD);
// Custom theme
$theme = Theme::fromJson('./themes/my-theme.json');
echo (new Renderer($theme))->render($markdown);What's in the box
CommonMark parserHeadings, paragraphs, lists, blockquotes, code blocks, tables, rules, links, images, HTML inline + block.
Nine themesansi, plain, notty, ascii, dark, light, dracula, tokyo-night, pink.
Custom JSON
Theme::fromJson('./my-theme.json') — element-keyed style overrides. An unreadable file throws RuntimeException carrying the read error, rather than leaking a PHP warning; Theme::fromJsonString() takes the JSON directly.Word-wrapConfigurable column width; honours SGR + grapheme cluster widths. List items and blockquotes charge only their own indent or 2-cell bar, so nested lines fit the wrap width as in glamour.
OSC 8 hyperlinksOptional
--no-hyperlinks toggle for terminals that don't support them. Email autolinks render the address hyperlinked to mailto: with no href suffix.Streaming
stream(iterable $chunks) yields rendered sections as markdown arrives, byte-identical to render(). Link reference definitions carry across sections; a section with an unresolved [..] is held back until a later definition resolves it or the document ends.Syntax highlightingCode blocks tokenised + coloured per language.
Source & demos
- Source on GitHub
- Full README
- Runnable examples
- Port of glamour (Go upstream)
See also
- CandySprinkles — styling primitives used by CandyShine
- SugarGlow — CLI markdown viewer that uses CandyShine for rendering
API
| Class | Method | Description |
|---|---|---|
| Renderer | new Renderer(?Theme $theme = null, …) | Create renderer with optional theme (also Renderer::ansi() / plain() / ascii() / fromEnvironment()) |
| Renderer | render(markdown) | Render markdown to ANSI string; a reused Renderer starts every render from a clean block stack |
| Renderer | stream(iterable $chunks): Generator / writer(StreamSink) | Incremental section-by-section rendering |
| Renderer | withWordWrap(?int) / withHyperlinks() / withBaseURL() / withTableWrap() / withPreservedNewLines() / withEmoji() / withSanitize() | Immutable option setters; withPreservedNewLines() keeps the source's blank-line runs between blocks |
| Theme | fromJson(path) / fromJsonString(json) | Load theme from a JSON file (RuntimeException with the read error on failure) or string |
| Theme | ansi(), plain(), notty(), ascii(), dark(), light(), dracula(), tokyoNight(), pink() | Built-in theme presets; byName() looks one up by name |
