BoxOfYellow.ConsoleMarkdownRenderer
0.5.0
dotnet add package BoxOfYellow.ConsoleMarkdownRenderer --version 0.5.0
NuGet\Install-Package BoxOfYellow.ConsoleMarkdownRenderer -Version 0.5.0
<PackageReference Include="BoxOfYellow.ConsoleMarkdownRenderer" Version="0.5.0" />
paket add BoxOfYellow.ConsoleMarkdownRenderer --version 0.5.0
#r "nuget: BoxOfYellow.ConsoleMarkdownRenderer, 0.5.0"
// Install BoxOfYellow.ConsoleMarkdownRenderer as a Cake Addin
#addin nuget:?package=BoxOfYellow.ConsoleMarkdownRenderer&version=0.5.0
// Install BoxOfYellow.ConsoleMarkdownRenderer as a Cake Tool
#tool nuget:?package=BoxOfYellow.ConsoleMarkdownRenderer&version=0.5.0
I have markdown files, you have markdown files we all have markdown files...
We create them to document various parts of projects. Sometimes that documentation would be helpful while folks are using those projects. And thats where this library comes in. This Library provides support for displaying markdown within the console and provides a simple navigation list of links and images within the document. When items from the list are selected their content will be shown inline when possible (aka it's another markdown file, or it's an image and the console appears to be using iTerm2)
I will totally admit README.md files and response that is displayed with --help are not 100% interchangeable, but there is a lot of overlap 🙂
Using it is simple
Just call the one public method from the static Displayer.cs class called DisplayMarkdown it accepts the following parameters
| name | type | description | required/default |
|---|---|---|---|
uri |
Uri |
The Uri that is either a file containing your markdown, or the web address where said content can be downloaded | Yes |
allowFollowingLinks |
bool |
A flag, when set to true, the list of links will be provided, when false the list is omitted | no / true |
includeDebug |
bool |
A flag, when set to true the content structure is displayed and detail of unsupported markdown is displayed | no / false |
It has a second overload
| name | type | description | required/default |
|---|---|---|---|
text |
string |
the text to display | Yes |
uriBase |
Uri |
The Uri base for all links | Yes |
allowFollowingLinks |
bool |
A flag, when set to true, the list of links will be provided, when false the list is omitted | no / true |
includeDebug |
bool |
A flag, when set to true the content structure is displayed and detail of unsupported markdown is displayed | no / false |
Checkout ConsoleMarkdownRenderer.Example to see it in use
Supporting packages
It's also important to give credit where credit is due, this library is really just glue for the following packages
- Markdig for parsing the markdown
- Spectre.Console for display rich formatting within the console
- RomanNumeral for minimal roman numeral processing
Contributing
Contributions are welcome, please see CONTRIBUTING.md and CODE_OF_CONDUCT.md
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 is compatible. 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 was computed. 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. |
-
net5.0
- Markdig (>= 0.26.0)
- RomanNumeral (>= 2.0.0)
- Spectre.Console (>= 0.42.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.