README.md

Syntax Highlighting extension for Markdig

An extension that adds Syntax Highlighting, also known as code colourization, to a Markdig pipeline through the power of ColorCode. By simply adding this extension to your pipeline, you can add colour and style to your source code:

Demonstration

Before

namespace Amido.VersionDashboard.Web.Domain {
    public interface IConfigProvider {
        string GetSetting(string appSetting);
    }
}

After

namespace Amido.VersionDashboard.Web.Domain {
    public interface IConfigProvider {
        string GetSetting(string appSetting);
    }
}

Usage

Simply import the nuget package, add a using statement for Markdig.SyntaxHighlighting and add to your pipeline:

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

Future Updates

• Upgrade ColorCode to support .NET Core / .NET Standard.
• Upgrade Markdig.SyntaxHighlighting to support .NET Core / .NET Standard.
• Add support for Code Coverage
• Add support for Dependency Checking