Installation & Usage

Get up and running in one line of code

This is a living document which means it is work in progress, not completed yet and can change at any time while the project is still in development major version zero 0.y.z!

Highlight.js prerequisites

Make sure to read the official highlight.js documentation lo learn how to install and use highlight.js in order to use themes like Nord.

Installation

Since Nord highlight.js is used in web technology based projects, it's main installation method are therefore npm or yarn, the Node.js package managers.

Install and add it as production dependency from the command line:

# When using npm...
npm install --save nord-highlightjs

# ...or yarn as package manager.
yarn add nord-highlightjs

To use Nord highlight.js in projects without Node.js, the CSS file can be used through CDN services like UNPKG:

<!-- Replace the version with any available release. -->
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />

Usage

To use Nord highlight.js include the CSS file as stylesheet depending on the installation method:

<!-- When installed via npm/yarn for Node.js based projects -->
<link href="node_modules/nord-highlightjs/dist/nord.css" rel="stylesheet" type="text/css" />
<!-- When using CDN service like UNPKG -->
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />