XenoAtom.Terminal.UI.Extensions.Markdown
1.3.0
Prefix Reserved
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package XenoAtom.Terminal.UI.Extensions.Markdown --version 1.3.0
NuGet\Install-Package XenoAtom.Terminal.UI.Extensions.Markdown -Version 1.3.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="XenoAtom.Terminal.UI.Extensions.Markdown" Version="1.3.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="XenoAtom.Terminal.UI.Extensions.Markdown" Version="1.3.0" />
<PackageReference Include="XenoAtom.Terminal.UI.Extensions.Markdown" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add XenoAtom.Terminal.UI.Extensions.Markdown --version 1.3.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: XenoAtom.Terminal.UI.Extensions.Markdown, 1.3.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package XenoAtom.Terminal.UI.Extensions.Markdown@1.3.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=XenoAtom.Terminal.UI.Extensions.Markdown&version=1.3.0
#tool nuget:?package=XenoAtom.Terminal.UI.Extensions.Markdown&version=1.3.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
XenoAtom.Terminal.UI.Extensions.Markdown
Markdown rendering for XenoAtom.Terminal.UI, powered by Markdig.
This package adds:
MarkdownControlandMarkdownDocumentContentto render Markdown intoDocumentFlowblocks.MarkdownMarkupConverterto convert Markdown into ANSI markup text for theMarkupcontrol.
It includes CommonMark support plus table and alert block extensions.
Quick start
using XenoAtom.Terminal.UI.Controls;
using XenoAtom.Terminal.UI.Extensions.Markdown;
var markdown = """
# Hello Markdown
Paragraph with **bold** text and [a link](https://example.com).
""";
var control = new MarkdownControl(markdown);
Convert interpreted markdown into markup:
var converter = new MarkdownMarkupConverter();
var markupText = converter.Convert(markdown);
var preview = new Markup(markupText).Wrap(true);
Preserve original markdown source (PromptEditor/syntax highlight scenarios):
var converter = new MarkdownMarkupConverter();
var sourceMarkup = converter.ConvertPreservingSource(markdown);
var runs = converter.Highlight(markdown); // StyledRun[] over the original markdown text
Features
- CommonMark block and inline rendering.
- Extensions enabled by default: pipe tables and alert blocks.
MarkdownRenderOptionsfor code block wrapping/height, compact spacing, and HTML/image fallbacks.- Theme-aware pleasant defaults (bright-yellow headings, accent strong text, bright-red inline code, semantic alerts).
MarkdownStylefor heading/link/emphasis/alert style customization.MarkdownDocumentContentfor direct usage withDocumentFlowfeeds.MarkdownMarkupConverterfor both interpreted rendering and source-preserving markdown highlighting (PromptEditor-ready).
Docs
- User docs:
site/docs/controls/markdowncontrol.md - User docs:
site/docs/controls/markdownmarkupconverter.md - Specs:
site/docs/specs/controls/markdowncontrol.md
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net10.0
- Markdig (>= 1.0.1)
- XenoAtom.Terminal.UI (>= 1.3.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.