Frank.Markdown
0.1.3-preview
This is a prerelease version of Frank.Markdown.
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 Frank.Markdown --version 0.1.3-preview
NuGet\Install-Package Frank.Markdown -Version 0.1.3-preview
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="Frank.Markdown" Version="0.1.3-preview" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Frank.Markdown --version 0.1.3-preview
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Frank.Markdown, 0.1.3-preview"
#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.
// Install Frank.Markdown as a Cake Addin #addin nuget:?package=Frank.Markdown&version=0.1.3-preview&prerelease // Install Frank.Markdown as a Cake Tool #tool nuget:?package=Frank.Markdown&version=0.1.3-preview&prerelease
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Frank.Markdown
A great fluent API for creating markdown documents in C#.
Installation
NuGet
Install-Package Frank.Markdown
Usage
Create a markdown document
var section1 = new MarkdownHeader("Header");
var section2 = new MarkdownHeader("Header", 2);
var items = new[] {"Item 1", "Item 2"};
var orderedList = new MarkdownOrderedList(items);
var unorderedList = new MarkdownUnorderedList(items);
var codeBlock = new MarkdownCodeBlock("var x = 1;");
var table = new MarkdownTable<MarkdownTableTestRow>(new List<MarkdownTableTestRow>
{
new() {Name = "Name 1", Value = 1, Vector = new Vector2(1, 2), Version = new Version(1, 2, 3)},
new() {Name = "Name 2", Value = 2, Vector = new Vector2(3, 4), Version = new Version(4, 5, 6)}
});
var alert = new MarkdownAlert("Urgent info that needs immediate user attention to avoid problems.", MarkdownAlertLevel.Warning);
var builder = new MarkdownBuilder();
.With(section1)
.WithHeader(section2)
.WithOrderedList(orderedList)
.WithUnorderedList(unorderedList)
.WithCodeBlock(codeBlock)
.WithTable(table)
.WithAlert(alert);
var result = builder.ToString();
Result
# Header
## Header
1. Item 1
2. Item 2
- Item 1
- Item 2
@```
var x = 1;
@```
| Name | Value | Vector | Version |
| --- | --- | --- | --- |
| Name 1 | 1 | <1 2> | 1.2.3 |
| Name 2 | 2 | <3 4> | 4.5.6 |
> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | 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. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net8.0
- No dependencies.
NuGet packages (1)
Showing the top 1 NuGet packages that depend on Frank.Markdown:
Package | Downloads |
---|---|
Frank.Reflection.Roslyn
Frank.Reflection contains helper classes and extension methods for .NET, like .GetDisplayName() on Type |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
1.3.0 | 104 | 7/19/2024 |
1.1.0 | 242 | 1/2/2024 |
1.0.4-preview | 85 | 1/2/2024 |
1.0.0 | 109 | 1/1/2024 |
0.1.3-preview | 85 | 1/1/2024 |