Skip to content

Commit 0e7638e

Browse files
teddclaude
andcommitted
docs: markdown, code-highlighting and inline-image feature tour
Website and docs now showcase rich content rendered directly in the console: MarkdownView (headings, lists, quotes, tables, inline styles), CodeDocument syntax highlighting (27 grammars) and inline images (Sixel/Kitty/iTerm2 with truecolor half-block fallback), each with a renderer-generated screenshot (markdown.svg, code.svg, images.svg). Also: supported-controls catalogue on the site and docs index, inline image setup guide + protocol table in the console guide, Windows Terminal 1.22+ Sixel support noted in the package table, and the install feature table now scrolls instead of overflowing the page on narrow viewports. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent 30b088c commit 0e7638e

8 files changed

Lines changed: 683 additions & 3 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1717
- **`TuiXamlView` Blazor component**: hosts a XAML-defined TUI (`Source` file/URL or inline `Xaml`, plus `Controller`), standalone or nested in a `TuiView`; `XamlSource` resolves files, app-base paths and HTTP.
1818
- **XamlLoader designer compatibility**: XML namespaces, prefixed elements, `x:Name` and designer attributes (`mc:Ignorable`, `d:DesignWidth`, `x:Class`, …) are now tolerated/ignored, so one file works in XAML editors and every host.
1919
- **Documentation**: `docs/` with getting-started (all hosts × XAML/programmatic), XAML guide, per-platform guides, and a GitHub Pages website (`docs/index.html`) with renderer-generated screenshots.
20+
- **Documentation — rich-content feature tour**: website and docs now showcase markdown rendering (`MarkdownView`), syntax highlighting (`CodeDocument`, 27 grammars) and inline images (Sixel/Kitty/iTerm2 + truecolor half-block fallback) with new renderer-generated screenshots (`docs/assets/markdown.svg`, `code.svg`, `images.svg`); added a supported-controls catalogue, an inline-image setup section to the console guide, and noted Windows Terminal 1.22+ Sixel support in the package table.
2021
- **Packaging/CI**: shared NuGet metadata + package icon for all 11 packages; deploy workflow packs and publishes every package on `deploy`/`deploy/prod` with rising versions (`VERSION` file + run number); CI moved to Windows with MAUI workload; GitHub Pages deploy workflow.
2122
- Initial release of **Tedd.TUI**.
2223
- Core framework architecture (`UIElement`, `DependencyProperty`, `Geometry`).

docs/README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,45 @@ terminal, a browser, and a desktop window.
1313
Blazor, Blazor Canvas, WPF, Avalonia, WinUI, MAUI), in both XAML and code.
1414
- **[XAML guide](xaml.md)** — the markup dialect, controller binding, designer compatibility.
1515

16+
## Rich content in the console
17+
18+
The core package renders rich content straight into the character grid — in a plain
19+
terminal just as on every GUI host:
20+
21+
- **Markdown**`MarkdownView` live-parses markdown into styled cells: headings, bold
22+
text, bullet lists, quotes, tables, inline code and hyperlinks, all themable via
23+
`MarkdownTheme`. Fenced code blocks are syntax-highlighted automatically and image
24+
references render inline.
25+
26+
![MarkdownView rendering markdown in the terminal](assets/markdown.svg)
27+
28+
- **Code highlighting**`CodeDocument` tokenizes source with a PrismJS-style grammar
29+
engine and renders colored cells, standalone or inside markdown fences. 27 grammars
30+
ship in the box: ASM 6502, ASP.NET, Bash, BASIC, Batch, C#, CIL, C-like, cshtml/Razor,
31+
CSS, CSV, Diff, JSON, JSON5, Lua, Markdown, NASM, Perl, PowerShell, Python, Regex,
32+
Rust, SQL, URI, WASM, XML/HTML and YAML.
33+
34+
![CodeDocument syntax highlighting C# and JSON](assets/code.svg)
35+
36+
- **Images** — the `Image` control puts real bitmaps into the cell grid: pixel-perfect
37+
Sixel (Windows Terminal 1.22+, VT340-style terminals), Kitty graphics and iTerm2
38+
(iTerm2/WezTerm/Ghostty) output in terminals, direct bitmap compositing on GUI and
39+
browser hosts, and a truecolor half-block fallback everywhere else. Decoding (PNG,
40+
JPEG, GIF, WebP, …) comes from `Tedd.TUI.Imaging`; see the
41+
[console guide](platforms/console.md#inline-images).
42+
43+
![Inline bitmap and half-block fallback rendering of the same photo](assets/images.svg)
44+
45+
## Controls
46+
47+
Border, Button, Canvas, CheckBox, CodeDocument, ComboBox, ContentControl, DataGrid,
48+
DialogBox, DockPanel, Expander, Grid, GridSplitter, GroupBox, Image, ItemsControl,
49+
ListBox, MarkdownView, MenuBar, MenuItem, PasswordBox, ProgressBar, RadioButton,
50+
ScrollBar, ScrollViewer, Separator, Slider, StackPanel, TabControl, TabItem, Table,
51+
TextBlock, TextBox, TextEditor, ToggleButton, TreeView, TreeViewItem, TuiWindow,
52+
UniformGrid, WrapPanel — plus WPF-style data binding, routed events, control templates
53+
and triggers.
54+
1655
## Platform hosts
1756

1857
| Host | Package | Guide |

docs/assets/code.svg

Lines changed: 101 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)