Markdig

https://github.com/xoofx/markdig
Admin
Markdig is a fast, powerful, CommonMark-compliant, extensible Markdown processor for .NET with 20+...
Tokens:315,497
Snippets:2,982
Trust Score:10
License:BSD-2-Clause
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Register renderers in Setup method

Source: https://github.com/xoofx/markdig/blob/main/site/docs/advanced/renderers.md

Register custom renderers in the extension's Setup method. Uses AddIfNotAlready to avoid duplicate registration.

```csharp
public void Setup(MarkdownPipeline pipeline, IMarkdownRenderer renderer)
{
    if (renderer is HtmlRenderer htmlRenderer)
    {
        // Add if not already present
        htmlRenderer.ObjectRenderers.AddIfNotAlready<HtmlNoteBlockRenderer>();
        htmlRenderer.ObjectRenderers.AddIfNotAlready<HtmlKeyboardRenderer>();
    }
}
```

--------------------------------

### Install Lunet as a .NET global tool

Source: https://github.com/xoofx/markdig/blob/main/site/AGENTS.md

Prerequisite for building the site. Installs the Lunet static site generator as a .NET global tool.

```sh
dotnet tool install -g lunet
```

--------------------------------

### Install Lunet and build/serve the site

Source: https://github.com/xoofx/markdig/blob/main/AGENTS.md

Install Lunet as a .NET global tool, then build the site for production or serve it locally with live reload. The production build outputs to .lunet/build/www/ and the dev server runs at http://localhost:4000.

```sh
dotnet tool install -g lunet
```

```sh
cd site
lunet build          # production build → .lunet/build/www/
lunet serve          # dev server with live reload at http://localhost:4000
```

--------------------------------

### Column width calculation example

Source: https://github.com/xoofx/markdig/blob/main/src/Markdig.Tests/Specs/GridTableSpecs.md

Example showing column widths calculated from the ratio of the first row separator lengths.

```markdown
+----+--------+----+
| A  |  B C D | E  |
+----+--------+----+
.
```

```html
<table>
<col style="width:25%" />
<col style="width:50%" />
<col style="width:25%" />
<tbody>
<tr>
<td>A</td>
<td>B C D</td>
<td>E</td>
</tr>
</tbody>
</table>
```

--------------------------------

### Tab at start of line in code block (example 8)

Source: https://github.com/xoofx/markdig/blob/main/src/Markdig.Benchmarks/spec.md

Example showing that a tab at the start of a line is treated as a space, so the line is part of the code block.

```markdown
    foo
→bar
.
<pre><code>foo
bar
</code></pre>
```

--------------------------------

### IMarkdownExtension interface with two Setup methods

Source: https://github.com/xoofx/markdig/blob/main/site/docs/advanced/pipeline.md

Defines the two-phase setup contract for Markdig extensions. Phase 1 runs during pipeline Build() to register or modify parsers; Phase 2 runs during rendering to register object renderers.

```csharp
public interface IMarkdownExtension
{
    // Phase 1: Called during Build() — register/modify parsers
    void Setup(MarkdownPipelineBuilder pipeline);

    // Phase 2: Called during rendering — register object renderers
    void Setup(MarkdownPipeline pipeline, IMarkdownRenderer renderer);
}
```

--------------------------------

### Valid row separator example

Source: https://github.com/xoofx/markdig/blob/main/src/Markdig.Tests/Specs/GridTableSpecs.md

A valid row separator example with its expected HTML output.

```markdown
+---------+---------+
| This is | a table |
.
```

```html
<table>
<col style="width:50%" />
<col style="width:50%" />
<tbody>
<tr>
<td>This is</td>
<td>a table</td>
</tr>
</tbody>
</table>
```

--------------------------------

### Markdown list example

Source: https://github.com/xoofx/markdig/blob/main/src/Markdig.Tests/RoundtripSpecs/CommonMark.md

The equivalent Markdown version of the AsciiDoc example, showing how list nesting is apparent in the source.

```markdown
1.  List item one.

    List item one continued with a second paragraph followed by an
    Indented block.

        $ ls *.sh
        $ mv *.sh ~/tmp

    List item continued with a third paragraph.

2.  List item two continued with an open block.

    This paragraph is part of the preceding list item.

    1. This list is nested and does not require explicit item continuation.

       This paragraph is part of the preceding list item.

    2. List item b.

    This paragraph belongs to item two of the outer list.
```

--------------------------------

### Complete NoteBlock rendering example

Source: https://github.com/xoofx/markdig/blob/main/site/docs/advanced/renderers.md

Complete example of a Markdig extension that adds a NoteBlock parser and renderer. The first block defines the extension and a fluent API method to register it. The second block shows how to use the extension to convert a note syntax to HTML.

```csharp
// Extension
public sealed class NoteExtension : IMarkdownExtension
{
    public void Setup(MarkdownPipelineBuilder pipeline)
    {
        pipeline.BlockParsers.AddIfNotAlready<NoteBlockParser>();
    }

    public void Setup(MarkdownPipeline pipeline, IMarkdownRenderer renderer)
    {
        if (renderer is HtmlRenderer htmlRenderer)
        {
            htmlRenderer.ObjectRenderers.AddIfNotAlready<HtmlNoteBlockRenderer>();
        }
    }
}

// Fluent API
public static class NoteExtensionMethods
{
    public static MarkdownPipelineBuilder UseNotes(
        this MarkdownPipelineBuilder pipeline)
    {
        pipeline.Extensions.AddIfNotAlready<NoteExtension>();
        return pipeline;
    }
}
```

```csharp
var pipeline = new MarkdownPipelineBuilder()
    .UseNotes()
    .Build();

var html = Markdown.ToHtml("!!! warning \"Be careful\"\n", pipeline);
```

--------------------------------

### Markdig quick example

Source: https://github.com/xoofx/markdig/blob/main/site/readme.md

C# example showing basic Markdig usage: converting CommonMark text with Markdown.ToHtml and enabling all advanced extensions via MarkdownPipelineBuilder().UseAdvancedExtensions().Build(). The expected output strings are shown in comments.

```csharp
using Markdig;

// Simple CommonMark conversion
var result = Markdown.ToHtml("This is a text with some *emphasis*");
// => "<p>This is a text with some <em>emphasis</em></p>\n"

// Enable all advanced extensions
var pipeline = new MarkdownPipelineBuilder().UseAdvancedExtensions().Build();
var result = Markdown.ToHtml("This is a ~~strikethrough~~", pipeline);
// => "<p>This is a <del>strikethrough</del></p>\n"
```

--------------------------------

### Header row separator example

Source: https://github.com/xoofx/markdig/blob/main/src/Markdig.Tests/Specs/GridTableSpecs.md

Example showing a header row separated by `+========+` instead of `+---------+`.

```markdown
+---------+---------+
| This is | a table |
+=========+=========+
.
```

```html
<table>
<col style="width:50%" />
<col style="width:50%" />
<thead>
<tr>
<th>This is</th>
<th>a table</th>
</tr>
</thead>
</table>
```

--------------------------------

### Alignment specification example

Source: https://github.com/xoofx/markdig/blob/main/src/Markdig.Tests/Specs/GridTableSpecs.md

Example showing alignment specified with `:` in the first row separator, producing a centered cell.

```markdown
+-----+:---:+-----+
|  A  |  B  |  C  |
+-----+-----+-----+
.
```

```html
<table>
<col style="width:33.33%" />
<col style="width:33.33%" />
<col style="width:33.33%" />
<tbody>
<tr>
<td>A</td>
<td style="text-align: center;">B</td>
<td>C</td>
</tr>
</tbody>
</table>
```

--------------------------------

### HTML output example

Source: https://github.com/xoofx/markdig/blob/main/site/docs/extensions/generic-attributes.md

Shows the Markdown input and the resulting HTML output for a paragraph with attributes.

```markdown
A paragraph. {.lead #intro}
```

```html
<p class="lead" id="intro">A paragraph.</p>
```

--------------------------------

### Tab before list marker (example 9)

Source: https://github.com/xoofx/markdig/blob/main/src/Markdig.Benchmarks/spec.md

Example showing that a tab before a list marker is treated as a space, allowing nested list continuation.

```markdown
 - foo
   - bar
→ - baz
.
<ul>
<li>foo
<ul>
<li>bar
<ul>
<li>baz</li>
</ul>
</li>
</ul>
</li>
</ul>
```

--------------------------------

### Install Markdig.Signed with dotnet CLI

Source: https://github.com/xoofx/markdig/blob/main/site/docs/getting-started.md

Adds the strong-named variant of Markdig to a .NET project.

```shell
dotnet add package Markdig.Signed
```

--------------------------------

### Markdown examples with spaces visualized

Source: https://github.com/xoofx/markdig/blob/main/src/Markdig/Roundtrip.md

Three markdown examples showing how spaces (visualized with the interpunct character ·) are placed around the list marker. All are valid markdown defining an unordered list with one paragraph block.

```markdown
·*·item1
```

```markdown
··*·item1
```

```markdown
·*··item1
```

--------------------------------

### HTML output for definition list

Source: https://github.com/xoofx/markdig/blob/main/site/docs/extensions/definition-lists.md

HTML output generated for the basic definition list example.

```html
<dl>
  <dt>Term 1</dt>
  <dd>Definition of term 1.</dd>
  <dt>Term 2</dt>
  <dd>Definition of term 2.</dd>
  <dd>Another definition of term 2.</dd>
</dl>
```

--------------------------------

### Configure MediaOptions and pipeline

Source: https://github.com/xoofx/markdig/blob/main/site/docs/extensions/media-links.md

C# example showing how to configure MediaOptions and enable the MediaLinks extension with custom width, height, and controls property.

```csharp
using Markdig.Extensions.MediaLinks;

var options = new MediaOptions
{
    Width = "800",
    Height = "450",
    AddControlsProperty = true
};

var pipeline = new MarkdownPipelineBuilder()
    .UseMediaLinks(options)
    .Build();
```

--------------------------------

### Heading with auto-generated ID

Source: https://github.com/xoofx/markdig/blob/main/site/docs/extensions/auto-identifiers.md

A heading like `## Getting Started` gets an `id` attribute derived from its text. The rendered HTML shows the generated ID.

```markdown
## Getting Started
```

```html
<h2 id="getting-started">Getting Started</h2>
```

--------------------------------

### Configure, build, and use a MarkdownPipeline

Source: https://github.com/xoofx/markdig/blob/main/site/docs/advanced/pipeline.md

Shows the three-step workflow: create a builder with UseAdvancedExtensions(), build an immutable pipeline, then use it with Markdown.ToHtml(). The builder is mutable and not thread-safe; build during startup and share the pipeline.

```csharp
// 1. Configure
var builder = new MarkdownPipelineBuilder()
    .UseAdvancedExtensions();

// 2. Build (immutable from here on)
var pipeline = builder.Build();

// 3. Use (thread-safe, reusable)
var html = Markdown.ToHtml(markdownText, pipeline);
```

--------------------------------

### List interrupting paragraph example

Source: https://github.com/xoofx/markdig/blob/main/src/Markdig.Tests/RoundtripSpecs/CommonMark.md

CommonMark allows lists to interrupt paragraphs, as it is natural and common to start lists without blank lines.

```markdown
I need to buy
- new shoes
- a coat
- a plane ticket
```

--------------------------------

### Link to auto-generated heading ID

Source: https://github.com/xoofx/markdig/blob/main/site/docs/extensions/auto-identifiers.md

Use the generated ID to link to a section. With the default `AutoLink` option, `[Getting Started]` also links to the heading.

```markdown
See [Getting Started](#getting-started).
```

--------------------------------

### Markdown table for width inference

Source: https://github.com/xoofx/markdig/blob/main/site/docs/extensions/tables.md

Example input for width inference. With `InferColumnWidthsFromSeparator = true`, the first column gets `Width = 25` and the second `Width = 75` (3:9 dash ratio).

```markdown
| A | B |
|---|--------|
| 1 | 2      |
```

--------------------------------

### Build and serve the Markdig documentation site

Source: https://github.com/xoofx/markdig/blob/main/site/AGENTS.md

Commands to build the site for production and run a development server with live reload. Run from the site/ directory.

```sh
lunet build          # production build → .lunet/build/www/
```

```sh
lunet serve          # dev server with live reload at http://localhost:4000
```

--------------------------------

### Roman list starting with a different numeral

Source: https://github.com/xoofx/markdig/blob/main/src/Markdig.Tests/Specs/ListExtraSpecs.md

Shows that a roman-numeral list can start with a different numeral. The output includes a start attribute reflecting the starting numeral.

```markdown
ii. First item
iii. Second item
.
<ol type="i" start="2">
<li>First item</li>
<li>Second item</li>
</ol>
```

--------------------------------

### Alpha list starting with a different letter

Source: https://github.com/xoofx/markdig/blob/main/src/Markdig.Tests/Specs/ListExtraSpecs.md

Shows that an alpha-ordered list can start with a different letter. The output includes a start attribute reflecting the starting letter.

```markdown
b. First item
c. Second item
.
<ol type="a" start="2">
<li>First item</li>
<li>Second item</li>
</ol>
```

--------------------------------

### Use custom renderer with Markdown.Convert

Source: https://github.com/xoofx/markdig/blob/main/site/docs/advanced/renderers.md

Use a custom renderer by building a pipeline, creating the renderer, calling pipeline.Setup(renderer) to configure extensions, and then passing the renderer and pipeline to Markdown.Convert.

```csharp
var pipeline = new MarkdownPipelineBuilder().UseAdvancedExtensions().Build();
var renderer = new LatexRenderer(writer);

// Setup extensions for the custom renderer
pipeline.Setup(renderer);

// Render
Markdown.Convert(markdownText, renderer, pipeline);
```

--------------------------------

### Ordered list start number with leading zero

Source: https://github.com/xoofx/markdig/blob/main/src/Markdig.Benchmarks/spec.md

Shows that a start number may begin with 0 and is preserved in the HTML start attribute.

```markdown
0. ok

```

```html
<ol start="0">
<li>ok</li>
</ol>

```

--------------------------------

### Ordered list start number with leading zeros

Source: https://github.com/xoofx/markdig/blob/main/src/Markdig.Benchmarks/spec.md

Shows that leading zeros in the start number are ignored; the HTML start attribute uses the numeric value.

```markdown
003. ok

```

```html
<ol start="3">
<li>ok</li>
</ol>

```

--------------------------------

### Ordered list start number (9 digits)

Source: https://github.com/xoofx/markdig/blob/main/src/Markdig.Benchmarks/spec.md

Shows that ordered list start numbers up to nine digits are allowed and produce an HTML start attribute.

```markdown
123456789. ok

```

```html
<ol start="123456789">
<li>ok</li>
</ol>

```

--------------------------------

### Configure MarkdownPipelineBuilder with extension tokens string

Source: https://github.com/xoofx/markdig/blob/main/site/docs/usage.md

Builds a pipeline using the Configure method with a string of extension tokens, useful for runtime configuration from a config file. Available tokens include common, advanced, alerts, pipetables, gfm-pipetables, emphasisextras, listextras, hardlinebreak, footnotes, footers, citations, attributes, gridtables, abbreviations, emojis, definitionlists, customcontainers, figures, mathematics, bootstrap, medialinks, smartypants, autoidentifiers, tasklists, diagrams, nofollowlinks, noopenerlinks, noreferrerlinks, nohtml, yaml, nonascii-noescape, autolinks, globalization, and cjk-friendly-emphasis.

```csharp
var pipeline = new MarkdownPipelineBuilder()
    .Configure("common+pipetables+footnotes+figures")
    .Build();
```

--------------------------------

### Changing ordered delimiter starts a new list

Source: https://github.com/xoofx/markdig/blob/main/src/Markdig.Tests/RoundtripSpecs/CommonMark.md

Changing the ordered list delimiter from '.' to ')' starts a new list, and the new list starts at the number of its first item (3).

```markdown
1. foo
2. bar
3) baz
.
<ol>
<li>foo</li>
<li>bar</li>
</ol>
<ol start="3">
<li>baz</li>
</ol>
```

--------------------------------

### Valid JIRA link with parentheses: (Z-1)

Source: https://github.com/xoofx/markdig/blob/main/src/Markdig.Tests/Specs/JiraLinks.md

Valid JIRA link example with parentheses and single-letter project key.

```markdown
This is a (Z-1) issue
.
<p>This is a (<a href="http://your.company.abc/browse/Z-1" target="_blank">Z-1</a>) issue</p>
```

--------------------------------

### Non-interrupting numeral 14

Source: https://github.com/xoofx/markdig/blob/main/src/Markdig.Tests/RoundtripSpecs/CommonMark.md

Only lists starting with '1' can interrupt paragraphs, so '14.' does not start a list.

```markdown
The number of windows in my house is
14.  The number of doors is 6.
.
<p>The number of windows in my house is
14.  The number of doors is 6.</p>
```

--------------------------------

### Cells spanning columns and rows example

Source: https://github.com/xoofx/markdig/blob/main/src/Markdig.Tests/Specs/GridTableSpecs.md

Example showing cells spanning both columns and rows.

```markdown
+---+---+---+
| AAAAA | B |
+---+---+ B +
| D | E | B |
+ D +---+---+
| D | CCCCC |
+---+---+---+
.
```

```html
<table>
<col style="width:33.33%" />
<col style="width:33.33%" />
<col style="width:33.33%" />
<tbody>
<tr>
<td colspan="2">AAAAA</td>
<td rowspan="2">B
B
B</td>
</tr>
<tr>
<td rowspan="2">D
D
D</td>
<td>E</td>
</tr>
<tr>
<td colspan="2">CCCCC</td>
</tr>
</tbody>
</table>
```

--------------------------------

### Build and test Markdig

Source: https://github.com/xoofx/markdig/blob/main/AGENTS.md

Build and test the Markdig solution from the project root. Run these commands in the src directory; all tests must pass before submitting.

```sh
cd src
dotnet build -c Release
dotnet test -c Release
```

--------------------------------

### Phase 1 Setup: register block parser and modify emphasis parser

Source: https://github.com/xoofx/markdig/blob/main/site/docs/advanced/pipeline.md

Phase 1 implementation: adds a custom block parser via AddIfNotAlready and modifies the existing EmphasisInlineParser by adding an EmphasisDescriptor for the '%' character with order 3, 3, and no emphasis.

```csharp
public void Setup(MarkdownPipelineBuilder pipeline)
{
    // Add a new block parser
    pipeline.BlockParsers.AddIfNotAlready<MyBlockParser>();

    // Or modify an existing parser
    var emphasisParser = pipeline.InlineParsers.FindExact<EmphasisInlineParser>();
    if (emphasisParser != null)
    {
        emphasisParser.EmphasisDescriptors.Add(
            new EmphasisDescriptor('%', 3, 3, false));
    }
}
```

--------------------------------

### Example of CJK emphasis sequences

Source: https://github.com/xoofx/markdig/blob/main/site/docs/extensions/cjk-friendly-emphasis.md

These Markdown examples show emphasis sequences that often fail with plain CommonMark in CJK text but become parseable with this extension enabled. The examples include Japanese, Chinese, and Korean text.

```markdown
**この文を強調できますか？**残念ながらできません。
我可以强调**这个`code`**吗？
**이 용어(This term)**를 강조해 주세요.
```

--------------------------------

### Omitted last column separator example

Source: https://github.com/xoofx/markdig/blob/main/src/Markdig.Tests/Specs/GridTableSpecs.md

Example showing that the last column separator `|` may be omitted.

```markdown
+---------+---------+
| This is | a table with a longer text in the second column
.
```

```html
<table>
<col style="width:50%" />
<col style="width:50%" />
<tbody>
<tr>
<td>This is</td>
<td>a table with a longer text in the second column</td>
</tr>
</tbody>
</table>
```

--------------------------------

### Run spec_tests.py

Source: https://github.com/xoofx/markdig/blob/main/src/Markdig.Tests/RoundtripSpecs/CommonMark.md

Run the conformance tests against any Markdown program using the spec_tests.py script.

```bash
python test/spec_tests.py --spec spec.txt --program PROGRAM
```

--------------------------------

### Invalid row separator example

Source: https://github.com/xoofx/markdig/blob/main/src/Markdig.Tests/Specs/GridTableSpecs.md

An invalid row separator example that is not recognized as a table and is rendered as a paragraph.

```markdown
|-----xxx----+---------+
| This is    | not a table
.
```

```html
<p>|-----xxx----+---------+
| This is    | not a table</p>
```

--------------------------------

### AsciiDoc list example

Source: https://github.com/xoofx/markdig/blob/main/src/Markdig.Tests/RoundtripSpecs/CommonMark.md

A sample of AsciiDoc from the AsciiDoc manual, illustrating its syntax for list items with continuation and indented blocks.

```asciidoc
1. List item one.
+
List item one continued with a second paragraph followed by an
Indented block.
+
.................
$ ls *.sh
$ mv *.sh ~/tmp
.................
+
List item continued with a third paragraph.

2. List item two continued with an open block.
+
--
This paragraph is part of the preceding list item.

a. This list is nested and does not require explicit item
continuation.
+
This paragraph is part of the preceding list item.

b. List item b.

This paragraph belongs to item two of the outer list.
--
```

--------------------------------

### List item with subparagraph example

Source: https://github.com/xoofx/markdig/blob/main/src/Markdig.Tests/RoundtripSpecs/CommonMark.md

Example of a list item with a subparagraph where the paragraph is not indented as far as the first paragraph.

```markdown
 10. foo

   bar  

```

--------------------------------

### BlockProcessor.TakeLinesBefore()

Source: https://github.com/xoofx/markdig/blob/main/site/docs/advanced/parser-authoring-api.md

Use this in `TryOpen` when `TrackTrivia` is enabled and the new block should own pending leading blank/trivia lines.

```APIDOC
## BlockProcessor.TakeLinesBefore()

### Description
Use this in `TryOpen` when `TrackTrivia` is enabled and the new block should own pending leading blank/trivia lines.

### Method
TakeLinesBefore

### Returns
- Returns current `LinesBefore` and clears it.
- Returns `null` when there is no pending list.
```

--------------------------------

### Build a MarkdownPipeline with UseAdvancedExtensions and UsePreciseSourceLocation

Source: https://github.com/xoofx/markdig/blob/main/site/docs/usage.md

Creates an immutable, thread-safe MarkdownPipeline with advanced extensions and precise source location tracking. The pipeline can be reused across threads and calls after building.

```csharp
var pipeline = new MarkdownPipelineBuilder()
    .UseAdvancedExtensions()  // Enable extensions
    .UsePreciseSourceLocation() // Track precise source spans
    .Build();                  // Produce the immutable pipeline
```

--------------------------------

### Negative ordered list start number not ok

Source: https://github.com/xoofx/markdig/blob/main/src/Markdig.Benchmarks/spec.md

Shows that negative start numbers are not allowed; the line is treated as a paragraph.

```markdown
-1. not ok

```

```html
<p>-1. not ok</p>

```

--------------------------------

### Run Markdig benchmarks

Source: https://github.com/xoofx/markdig/blob/main/site/docs/advanced/performance.md

Run the Markdig benchmarks project to measure performance. Use Release configuration for accurate results.

```bash
cd src
dotnet run -c Release --project Markdig.Benchmarks
```

--------------------------------

### Start HTML block with non-block-level tag

Source: https://github.com/xoofx/markdig/blob/main/src/Markdig.Benchmarks/spec.md

To start an HTML block with a non-block-level tag, the tag must be on its own line and complete.

```markdown
<a href="foo">
*bar*
</a>

```

```html
<a href="foo">
*bar*
</a>

```

--------------------------------

### Valid JIRA link: KIRA-1

Source: https://github.com/xoofx/markdig/blob/main/src/Markdig.Tests/Specs/JiraLinks.md

Valid JIRA link example with project key KIRA-1 and issue number 1.

```markdown
This is a KIRA-1 issue
.
<p>This is a <a href="http://your.company.abc/browse/KIRA-1" target="_blank">KIRA-1</a> issue</p>
```

--------------------------------

### Valid JIRA link with parentheses: (KIRA-1)

Source: https://github.com/xoofx/markdig/blob/main/src/Markdig.Tests/Specs/JiraLinks.md

Valid JIRA link example with parentheses and single-digit issue number.

```markdown
This is a (KIRA-1) issue
.
<p>This is a (<a href="http://your.company.abc/browse/KIRA-1" target="_blank">KIRA-1</a>) issue</p>
```

--------------------------------

### Correct and Incorrect Pipeline Usage

Source: https://github.com/xoofx/markdig/blob/main/site/docs/usage.md

Demonstrates the correct way to use the same pipeline for both parse and render, and shows two incorrect approaches: using a different pipeline for rendering (missing PipeTables) and using no pipeline for rendering. The incorrect approaches cause tables to not render correctly or extensions to be skipped.

```csharp
// ✅ Correct — same pipeline for parse and render
var pipeline = new MarkdownPipelineBuilder().UsePipeTables().Build();
var document = Markdown.Parse(markdownText, pipeline);
var html = document.ToHtml(pipeline);

// ❌ Wrong — pipeline mismatch
var parsePipeline = new MarkdownPipelineBuilder().UsePipeTables().Build();
var renderPipeline = new MarkdownPipelineBuilder().Build(); // missing PipeTables
var document = Markdown.Parse(markdownText, parsePipeline);
var html = document.ToHtml(renderPipeline); // Tables won't render correctly!

// ❌ Also wrong — no pipeline for render
var document = Markdown.Parse(markdownText, pipeline);
var html = document.ToHtml(); // Uses default pipeline — no extensions!
```

--------------------------------

### List starting with empty item

Source: https://github.com/xoofx/markdig/blob/main/src/Markdig.Tests/RoundtripSpecs/CommonMark.md

A list may start or end with an empty list item. The expected HTML output is shown.

```markdown
*

```

```html
<ul>
<li></li>
</ul>

```

--------------------------------

### Tabs after list marker (example 7)

Source: https://github.com/xoofx/markdig/blob/main/src/Markdig.Benchmarks/spec.md

Example showing that tabs after a list marker are treated as spaces, creating a code block.

```markdown
-→→foo
.
<ul>
<li>
<pre><code>  foo
</code></pre>
</li>
</ul>
```

--------------------------------

### Valid JIRA link: Z-1

Source: https://github.com/xoofx/markdig/blob/main/src/Markdig.Tests/Specs/JiraLinks.md

Valid JIRA link example with single-letter project key Z-1.

```markdown
This is a Z-1 issue
.
<p>This is a <a href="http://your.company.abc/browse/Z-1" target="_blank">Z-1</a> issue</p>
```

--------------------------------

### Register extension instance with Use(ext)

Source: https://github.com/xoofx/markdig/blob/main/site/docs/advanced/creating-extensions.md

Registers an extension instance that requires configuration by passing it to the Use(extension) method.

```csharp
var ext = new MyExtension(someConfig);
var pipeline = new MarkdownPipelineBuilder()
    .Use(ext)
    .Build();
```

--------------------------------

### Tabs in code block (example 1)

Source: https://github.com/xoofx/markdig/blob/main/src/Markdig.Benchmarks/spec.md

Example showing that tabs are not expanded to spaces in code blocks. The arrow character represents a tab.

```markdown
→foo→baz→→bim
.
<pre><code>foo→baz→→bim
</code></pre>
```

--------------------------------

### Parse and render a document with the same pipeline

Source: https://github.com/xoofx/markdig/blob/main/site/docs/getting-started.md

Shows the two-step process of parsing a Markdown string into a document and then rendering it to HTML. The same pipeline must be used for both steps to ensure correct output.

```csharp
using Markdig;
using Markdig.Syntax;

var pipeline = new MarkdownPipelineBuilder()
    .UseAdvancedExtensions()
    .Build();

// Step 1: Parse
var document = Markdown.Parse("A ~~strikethrough~~ example.", pipeline);

// Step 2: Render
var html = document.ToHtml(pipeline);
Console.WriteLine(html);
```

--------------------------------

### Valid JIRA link with parentheses: (ABC4-123)

Source: https://github.com/xoofx/markdig/blob/main/src/Markdig.Tests/Specs/JiraLinks.md

Valid JIRA link example with parentheses and digits in project key.

```markdown
This is a (ABC4-123) issue
.
<p>This is a (<a href="http://your.company.abc/browse/ABC4-123" target="_blank">ABC4-123</a>) issue</p>
```

--------------------------------

### Tabs after block quote marker (example 6)

Source: https://github.com/xoofx/markdig/blob/main/src/Markdig.Benchmarks/spec.md

Example showing that tabs after a block quote marker are treated as spaces, creating a code block.

```markdown
>→→foo
.
<blockquote>
<pre><code>  foo
</code></pre>
</blockquote>
```

--------------------------------

### Tab after blank line in list (example 4)

Source: https://github.com/xoofx/markdig/blob/main/src/Markdig.Benchmarks/spec.md

Example showing that a tab after a blank line is treated as a space, so the paragraph continues inside the list item.

```markdown
  - foo

→bar
.
<ul>
<li>
<p>foo</p>
<p>bar</p>
</li>
</ul>
```

--------------------------------

### Benchmark your extension

Source: https://github.com/xoofx/markdig/blob/main/site/docs/advanced/performance.md

Add a benchmark method to the benchmarks project to measure your extension's performance. Uses BenchmarkDotNet attributes.

```csharp
[Benchmark]
public string ConvertWithMyExtension()
{
    return Markdown.ToHtml(MarkdownText, _pipelineWithMyExtension);
}
```

--------------------------------

### Two tabs after blank line in list (example 5)

Source: https://github.com/xoofx/markdig/blob/main/src/Markdig.Benchmarks/spec.md

Example showing that two tabs after a blank line create a code block inside the list item.

```markdown
- foo

→→bar
.
<ul>
<li>
<p>foo</p>
<pre><code>  bar
</code></pre>
</li>
</ul>
```

--------------------------------

### Tabs in code block with Unicode (example 3)

Source: https://github.com/xoofx/markdig/blob/main/src/Markdig.Benchmarks/spec.md

Example showing that tabs are preserved in code blocks, including Unicode characters. The arrow character represents a tab.

```markdown
    a→a
    ὐ→a
.
<pre><code>a→a
ὐ→a
</code></pre>
```

--------------------------------

### Enable advanced extensions with UseAdvancedExtensions

Source: https://github.com/xoofx/markdig/blob/main/site/docs/getting-started.md

Builds a pipeline with all advanced extensions and uses it to convert Markdown to HTML. The output shows strikethrough rendered as <del>.

```csharp
using Markdig;

// Build a pipeline with all advanced extensions
var pipeline = new MarkdownPipelineBuilder()
    .UseAdvancedExtensions()
    .Build();

var html = Markdown.ToHtml("This is ~~deleted~~ text.", pipeline);
Console.WriteLine(html);
// Output: <p>This is <del>deleted</del> text.</p>
```

--------------------------------

### Configure MarkdownPipelineBuilder with PipeTables, Footnotes, EmphasisExtras, AutoLinks, and GenericAttributes

Source: https://github.com/xoofx/markdig/blob/main/site/docs/usage.md

Configures a pipeline with several extensions using the fluent builder API. UseGenericAttributes must be added last because it modifies other parsers to support {.class #id} syntax.

```csharp
var pipeline = new MarkdownPipelineBuilder()
    .UsePipeTables()
    .UseFootnotes()
    .UseEmphasisExtras()
    .UseAutoLinks()
    .UseGenericAttributes() // Must be last (modifies other parsers)
    .Build();
```
Tokens:
Raw