Markdown.ColorCode 2.3.0

dotnet add package Markdown.ColorCode --version 2.3.0                
NuGet\Install-Package Markdown.ColorCode -Version 2.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="Markdown.ColorCode" Version="2.3.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Markdown.ColorCode --version 2.3.0                
#r "nuget: Markdown.ColorCode, 2.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 Markdown.ColorCode as a Cake Addin
#addin nuget:?package=Markdown.ColorCode&version=2.3.0

// Install Markdown.ColorCode as a Cake Tool
#tool nuget:?package=Markdown.ColorCode&version=2.3.0                

Markdown.ColorCode

Build Coverage

Version Downloads

Contributor Covenant Contributors Commits

Forks Stargazers Issues MIT License

LinkedIn

About The Project

An extension for Markdig that adds syntax highlighting to code through the power of ColorCode.

Demonstration

Before

using Foo.Bar.Baz;

namespace Foo.Api;

public interface FooService {
    /// <summary>
    ///     Gets a new Foo!
    /// </summary>
    /// <returns>A new Foo</returns>
    public void GetFoo() {
        return new Foo();
    }
}

After

using Foo.Bar.Baz;

namespace Foo.Api;

public interface FooService {
    /// <summary>
    ///     Gets a new Foo!
    /// </summary>
    /// <returns>A new Foo</returns>
    public void GetFoo() {
        return new Foo();
    }
}

Installation

Package Manager

Install-Package Markdown.ColorCode -Version 2.3.0

.NET CLI

dotnet add package Markdown.ColorCode --version 2.3.0

Usage

To use this extension with Markdig, simply install the Markdown.ColorCode package use the ColorCode extension:

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

var colorizedHtml = Markdig.Markdown.ToHtml(someMarkdown, pipeline);

Several optional configuration options are also at your disposal:

var pipeline = new MarkdownPipelineBuilder()
    .UseAdvancedExtensions()
    .UseColorCode(
        HtmlFormatterType.Style, // use style-based colorization (default)
        myCustomStyleDictionary, // use a custom colorization style dictionary
        myAdditionalLanguages, // augment the built-in language support
        myCustomLanguageId // set a default language ID to fall back to
    )
    .Build();

var colorizedHtml = Markdig.Markdown.ToHtml(someMarkdown, pipeline);

Improved C# Syntax Highlighting

For an improved experience with C# code blocks, consider using the Markdown.ColorCode.CSharpToColoredHtml package. This package provides a more robust syntax highlighting experience for C# code blocks by leveraging CSharpToColouredHtml.Core.

var pipeline = new MarkdownPipelineBuilder()
    .UseAdvancedExtensions()
    .UseColorCodeWithCSharpToColoredHtml(
        HtmlFormatterType.Style, // use style-based colorization (default)
        myCustomStyleDictionary, // use a custom colorization style dictionary
        myHtmlEmitterSettings, // configures CSharpToColouredHtml's HTML emitter
        myAdditionalLanguages, // augment the built-in language support
        myCustomLanguageId // set a default language ID to fall back to
    )
    .Build();

var colorizedHtml = Markdig.Markdown.ToHtml(someMarkdown, pipeline);

[!NOTE] The CsharpToColouredHTML package introduces dependencies which will not work well with Blazor WebAssembly projects. Either generate the HTML on the server side and send it to the client or use the base Markdown.ColorCode package if you are working with Blazor WebAssembly. See https://github.com/dotnet/aspnetcore/issues/27373 and https://github.com/dotnet/aspnetcore/issues/26724 for more details on the problem.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. For detailed contributing guidelines, please see CONTRIBUTING.md.

License

Distributed under the MIT License License. See LICENSE for more information.

Contact

@wbaldoumas

Project Link: https://github.com/wbaldoumas/markdown-colorcode

Acknowledgements

This README was adapted from https://github.com/othneildrew/Best-README-Template.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  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 is compatible.  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 is compatible.  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 netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  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 tizen40 was computed.  tizen60 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 (2)

Showing the top 2 NuGet packages that depend on Markdown.ColorCode:

Package Downloads
Markdown.ColorCode.CSharpToColoredHtml

An extension for Markdig that adds syntax highlighting to code through the power of ColorCode, boosted with the CsharpToColouredHTML.Core package.

DevToys.Tools

A set of offline tools installed by default with DevToys.

GitHub repositories (2)

Showing the top 2 popular GitHub repositories that depend on Markdown.ColorCode:

Repository Stars
ktutak1337/Stellar-Chat
A versatile multi-modal chat application that enables users to develop custom agents, create images, leverage visual recognition, and engage in voice interactions. It integrates seamlessly with local LLMs and commercial models like OpenAI, Gemini, Perplexity, and Claude, and allows to converse with uploaded documents and websites.
deanthecoder/GLSLShaderShrinker
Cross-platform tool to Reformat/Remove Dead Code/Optimise/Analyse GLSL shader code.
Version Downloads Last updated
2.3.0 11,411 7/17/2024
2.2.2 6,915 4/30/2024
2.2.1 6,250 2/18/2024
2.2.0 375 2/13/2024
2.2.0-preview-5 115 2/13/2024
2.2.0-preview-4 124 2/12/2024
2.1.0 13,934 11/16/2023
2.0.0 4,943 9/3/2023
2.0.0-preview-1 136 8/23/2023
1.1.2 2,848 8/18/2023
1.1.1 1,812 8/1/2023
1.1.0 158 8/1/2023
1.1.0-preview-1 155 7/30/2023
1.0.4 5,697 5/26/2023
1.0.4-preview-2 136 5/25/2023
1.0.3 3,401 3/12/2023
1.0.2 7,988 12/10/2022
1.0.1 12,039 3/19/2022
1.0.0 1,077 1/20/2022
0.1.0 629 1/15/2022