🌟 CandyShine
Markdown → ANSI renderer
Built on league/commonmark + CandySprinkles. Word-wrap, OSC 8 hyperlinks, syntax highlighting, eight 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.
Eight themesansi, plain, notty, dark, light, dracula, tokyo-night, pink.
Custom JSON
Theme::fromJson('./my-theme.json') — element-keyed style overrides.Word-wrapConfigurable column width; honours SGR + grapheme cluster widths.
OSC 8 hyperlinksOptional
--no-hyperlinks toggle for terminals that don't support them.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(?Theme) | Create renderer with optional theme |
| Renderer | render(markdown) | Render markdown to ANSI string |
| Theme | fromJson(path) | Load theme from JSON file |
| Theme | ansi(), dark(), light(), dracula() | Built-in theme presets |
