josefpihrt/dotmarkdown

DotMarkdown is Markdown framework for .NET

DotMarkdown

Introduction

• DotMarkdown is a framework for creating markdown content
• The library is distributed as .

Supported Frameworks

• .NET Standard 1.3
• .NET Framework 4.6

Documentation

• Reference 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;

Links

• Mastering Markdown
• Markdown Cheatsheet
• Markdown Guide
• Daring Fireball: Markdown Syntax Documentation
• CommonMark Spec

dotmarkdown's Issues

Add project DotMarkdown.Docusaurus

• Admonitions - https://docusaurus.io/docs/markdown-features/admonitions
• Code Block Title - https://docusaurus.io/docs/markdown-features/code-blocks#code-title

Make class Emojis obsolete

Add documentation comments

Add methods to MFactory

• Text(string text)
• Autolink(string url)
• LinkOrAutolink(string url, string text = null, string title = null)

Add support for escaping angled brackets (< and >) as &lt; and &gt;

Currently angled brackets are escaped with a backslash. However some markdown processors don't really seem to like this. Would love to have an option to escape these as their XML char entities instead, i.e. < and >.

Add methods WriteStartInlineCode, WriteEndInlineCode

Add overload MarkdownWriter.Create(string, MarkdownWriterSettings)

Add method WriteParagraph

[Question] Perhaps the prefix "Write" for methods of an object MarkdownWriter is superfluous?

Perhaps the prefix "Write" for methods of an object MarkdownWriter is superfluous?

Write bold text inside link text

Add MarkdownOptions.AutoTableHeaderSeparator

Improve README.md

Escape pipe inside inline code inside table

Make structs read-only

Fix indentation of nested ordered item

Actual Behavior:

1. a
  2. b

Expected Behavior:

1. a
   2. b

Thanks and Contributing

I have been looking for ages for a library like this thanks for actually making one! Keep up the good work and getting stuff out there for those of us who are too lazy. Do you intend to be accepting pull requests I would love to help when I can.

Move GitHub task list and task item to separate package

How to create a Table?

I don't understand how to use for instance DotMarkdown.MarkdownBaseWriter.WriteStartTableCell()

I get exceptions, like:

Cannot write 'TableCell' when state is 'Table'

How do I get out of that state? In what order should the methods be called?

Add overloads to MElement.Save

• MElement.Save(string filePath, MarkdownFormat format = null)
• MElement.Save(Stream stream, MarkdownFormat format = null)