nordtheme / highlightjs

An arctic, north-bluish clean and elegant highlight.js theme.
https://www.nordtheme.com/ports/highlightjs
MIT License
55 stars 6 forks source link
color highlight highlighting js nord style syntax theme

An arctic, north-bluish clean and elegant highlight.js theme.

Designed for a fluent and clear workflow based on the Nord color palette.

## Getting started Visit the [official website][nord-home] to learn all about the [features][nord-home#intro], how to [install and use][nord-docs-home-install] the theme and more from the [official documentations][nord-docs-home]. ### Quick Start 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: ```sh # 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][]: ```html ``` #### Usage To use Nord highlight.js include the CSS file as stylesheet depending on the installation method: ```sh ``` ## Features

Beautiful code to keep focused.

Support for a wide range of language types.

JavaScript with a React Hook for React Spring animations.

React component with forwarded ref.

## Contributing Nord is an open source project and we love to receive contributions from the [community][nord-comm]! There are many ways to contribute, from [writing- and improving documentation and tutorials][nord-contrib-guide-docs], [reporting bugs][nord-contrib-guide-bugs], [submitting enhancement suggestions][nord-contrib-guide-enhance] that can be added to Nord by [submitting pull requests][nord-contrib-guide-pr]. Please take a moment to read Nord's full [contributing guide][nord-contrib-guide] to learn about the development process, the project's used [styleguides][nord-contrib-guide-styles], [branch organization][nord-contrib-guide-branching] and [versioning][nord-contrib-guide-versioning] model. The guide also includes information about [minimal, complete, and verifiable examples][nord-contrib-guide-mcve] and other ways to contribute to the project like [improving existing issues][nord-contrib-guide-impr-issues] and [giving feedback on issues and pull requests][nord-contrib-guide-feedback].

Copyright © 2016-present Sven Greb

[node.js]: https://nodejs.org [nord-comm]: https://www.nordtheme.com/community [nord-contrib-guide-branching]: https://github.com/nordtheme/.github/blob/main/contributing.md#branch-organization [nord-contrib-guide-bugs]: https://github.com/nordtheme/.github/blob/main/contributing.md#bug-reports [nord-contrib-guide-docs]: https://github.com/nordtheme/.github/blob/main/contributing.md#documentations [nord-contrib-guide-enhance]: https://github.com/nordtheme/.github/blob/main/contributing.md#enhancement-suggestions [nord-contrib-guide-feedback]: https://github.com/nordtheme/.github/blob/main/contributing.md#feedback [nord-contrib-guide-impr-issues]: https://github.com/nordtheme/.github/blob/main/contributing.md#improve-issues [nord-contrib-guide-mcve]: https://github.com/nordtheme/.github/blob/main/contributing.md#mcve [nord-contrib-guide-pr]: https://github.com/nordtheme/.github/blob/main/contributing.md#pull-requests [nord-contrib-guide-styles]: https://github.com/nordtheme/.github/blob/main/contributing.md#style-guides [nord-contrib-guide-versioning]: https://github.com/nordtheme/.github/blob/main/contributing.md#versioning [nord-contrib-guide]: https://github.com/nordtheme/.github/blob/main/contributing.md [nord-docs-home-install]: https://www.nordtheme.com/docs/ports/highlightjs/installation [nord-docs-home]: https://www.nordtheme.com/docs/ports/highlightjs [nord-home]: https://www.nordtheme.com/ports/highlightjs [nord-home#intro]: https://www.nordtheme.com/ports/highlightjs#introduction [npm]: https://www.npmjs.com [unpkg]: https://unpkg.com [yarn]: https://yarnpkg.com