MDView.Renderer
0.1.0
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 MDView.Renderer --version 0.1.0
NuGet\Install-Package MDView.Renderer -Version 0.1.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="MDView.Renderer" Version="0.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="MDView.Renderer" Version="0.1.0" />
<PackageReference Include="MDView.Renderer" />
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 MDView.Renderer --version 0.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: MDView.Renderer, 0.1.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 MDView.Renderer@0.1.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=MDView.Renderer&version=0.1.0
#tool nuget:?package=MDView.Renderer&version=0.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
MDView
A terminal-based markdown viewer that renders markdown files with syntax-highlighted code blocks using rich console output.
Features
- Full markdown rendering in the terminal (headings, lists, blockquotes, tables, links, emphasis, etc.)
- Syntax-highlighted fenced code blocks powered by TextMate grammars (30+ languages)
- Supports reading from a file path or piped stdin
- Styled output via Spectre.Console
Requirements
Usage
# View a markdown file
dotnet run --project MDView -- README.md
# Pipe from stdin
cat README.md | dotnet run --project MDView
Building
dotnet build
Project Structure
| Project | Description |
|---|---|
| MDView | CLI tool — reads files/stdin and displays rendered output |
| MDView.Renderer | Class library — parses markdown and produces Spectre.Console renderables, packageable as a NuGet package |
Using the Renderer as a Library
using MDView;
using Spectre.Console;
var renderable = MarkdownRenderer.Render("# Hello, World!");
AnsiConsole.Write(renderable);
Dependencies
- Markdig — Markdown parsing
- Spectre.Console — Rich terminal rendering and CLI framework
- TextMateSharp — VS Code-style syntax highlighting
License
| 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 (>= 0.45.0)
- Spectre.Console (>= 0.54.0)
- TextMateSharp (>= 2.0.3)
- TextMateSharp.Grammars (>= 2.0.3)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.