Skip to content

asears/DotMarkdown

 
 

Repository files navigation

DotMarkdown

Introduction

  • DotMarkdown is Markdown framework for .NET
  • The library is distributed as NuGet.

Supported Frameworks

  • .NET Standard 1.3
  • .NET Framework 4.5

Documentation

Usage

Commonly Used Types

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

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;");
}

Output

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

## Bullet List

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

## Indented Code Block

    string s = null;

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;"));

Output

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

## Bullet List

* text
* **bold text**

- - -

## IndentedCodeBlock

    string s = null;

Links

About

DotMarkdown is Markdown framework for .NET

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 98.9%
  • Batchfile 1.1%