MDView.Renderer
0.3.0
.NET 8.0
This package targets .NET 8.0. The package is compatible with this framework or higher.
.NET Standard 2.0
This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
dotnet add package MDView.Renderer --version 0.3.0
NuGet\Install-Package MDView.Renderer -Version 0.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="MDView.Renderer" Version="0.3.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="MDView.Renderer" Version="0.3.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.3.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: MDView.Renderer, 0.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 MDView.Renderer@0.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=MDView.Renderer&version=0.3.0
#tool nuget:?package=MDView.Renderer&version=0.3.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 | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. 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. |
| .NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
| .NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen40 was computed. tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETStandard 2.0
- IndexRange (>= 1.0.3)
- Markdig (>= 0.45.0)
- Microsoft.Bcl.HashCode (>= 6.0.0)
- Spectre.Console (>= 0.54.0)
- TextMateSharp (>= 2.0.3)
- TextMateSharp.Grammars (>= 2.0.3)
-
net10.0
- Markdig (>= 0.45.0)
- Spectre.Console (>= 0.54.0)
- TextMateSharp (>= 2.0.3)
- TextMateSharp.Grammars (>= 2.0.3)
-
net8.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.