DotMarkdown 0.3.0

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
dotnet add package DotMarkdown --version 0.3.0
NuGet\Install-Package DotMarkdown -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="DotMarkdown" Version="0.3.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add DotMarkdown --version 0.3.0
#r "nuget: DotMarkdown, 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.
// Install DotMarkdown as a Cake Addin
#addin nuget:?package=DotMarkdown&version=0.3.0

// Install DotMarkdown as a Cake Tool
#tool nuget:?package=DotMarkdown&version=0.3.0

DotMarkdown

DotMarkdown enables to conveniently create markdown content from the code.

Supported Frameworks

  • .NET Standard 1.3
  • .NET Framework 4.5

Documentation

Usage

Commonly Used Types

  • DotMarkdown.MarkdownWriter
  • DotMarkdown.MarkdownWriterSettings
  • DotMarkdown.MarkdownFormat
  • DotMarkdown.Linq.MFactory

How to Use MarkdownWriter

using System.Text;
using DotMarkdown;

var sb = new StringBuilder();

using (MarkdownWriter writer = MarkdownWriter.Create(sb))
{
    writer.WriteHeading1("Markdown Sample");
    writer.WriteHeading2("Bullet List");
    writer.WriteBulletItem("text");
    writer.WriteStartBulletItem();
    writer.WriteBold("bold text");
    writer.WriteEndBulletItem();

    writer.WriteHorizontalRule();

    writer.WriteHeading2("Indented Code Block");
    writer.WriteIndentedCodeBlock("string s = null;");
}

Console.WriteLine(sb.ToString());
Output
# Markdown Sample

## Bullet List

* text
* **bold text**
- - -

## Indented Code Block

    string s = null;

How to Use LINQ to Markdown

using DotMarkdown.Linq;
using static DotMarkdown.Linq.MFactory;

MDocument document = Document(
    Heading1("Markdown Sample"),
    Heading2("Bullet List"),
    BulletList(
        "text",
        Bold("bold text")),
    HorizontalRule(),
    Heading2("IndentedCodeBlock"),
    IndentedCodeBlock("string s = null;"));

Console.WriteLine(document.ToString());
Output
# Markdown Sample

## Bullet List

* text
* **bold text**

- - -

## IndentedCodeBlock

    string s = null;
Product 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 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. 
.NET Core netcoreapp1.0 was computed.  netcoreapp1.1 was computed.  netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard1.3 is compatible.  netstandard1.4 was computed.  netstandard1.5 was computed.  netstandard1.6 was computed.  netstandard2.0 was computed.  netstandard2.1 was computed. 
.NET Framework net46 was computed.  net461 was computed.  net462 is compatible.  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 tizen30 was computed.  tizen40 was computed.  tizen60 was computed. 
Universal Windows Platform uap was computed.  uap10.0 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.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on DotMarkdown:

Package Downloads
DotMarkdown.Docusaurus The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Extension of DotMarkdown package for Docusaurus markdown

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on DotMarkdown:

Repository Stars
dotnet/roslynator
Roslynator is a set of code analysis tools for C#, powered by Roslyn.
Version Downloads Last updated
0.3.0 4,195 8/17/2023
0.3.0-beta 767 7/27/2023
0.2.0 8,912 6/26/2022
0.1.1 1,230 10/27/2020
0.1.0 2,899 8/21/2018
0.1.0-rc 966 4/4/2018
0.1.0-beta 908 1/30/2018