Skip to content
Open core software, built in Singapore Established 2018  /  Five utilities
Jering
Talk to us

Documentation home

Web.SyntaxHighlighters.HighlightJS Jering documentation Open source NuGet package
Documentation menu

A .NET wrapper around highlight.js. It runs the highlighter in Node.js and returns highlighted markup that uses the standard hljs class prefix.

Start here

Install

Package Manager
dotnet add package Jering.Web.SyntaxHighlighters.HighlightJS

What it does

A .NET wrapper around highlight.js. It runs the highlighter in Node.js and returns highlighted markup that uses the standard hljs class prefix.

  • Highlight source code with a highlight.js language alias.
  • Set a custom class prefix when your styles require one.
  • Validate language aliases before highlighting.
  • Use dependency injection or the StaticHighlightJSService wrapper.

Requirements

Target framework.NET Standard 2.0 and .NET Framework 4.6.1
PlatformsWindows and macOS
PrerequisiteNode.js 10.5.2 to 12.13.0 tested
DistributionNuGet package

Reference shelf