diff --git a/README.md b/README.md index 94cf35c2..e74fde85 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,102 @@ -
+ - + - + - + - + -The official Nord website and documentation
+ + +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**][npm] or [**yarn**][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
.
Copyright © 2017-present Arctic Ice Studio and Sven Greb
+ + + +[node.js]: https://nodejs.org +[nord-comm]: https://www.nordtheme.com/community +[nord-contrib-guide-branching]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#branch-organization +[nord-contrib-guide-bugs]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#bug-reports +[nord-contrib-guide-docs]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#documentations +[nord-contrib-guide-enhance]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#enhancement-suggestions +[nord-contrib-guide-feedback]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#give-feedback-on-issues-and-pull-requests +[nord-contrib-guide-impr-issues]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#improve-issues +[nord-contrib-guide-mcve]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#mcve +[nord-contrib-guide-pr]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#pull-requests +[nord-contrib-guide-styles]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#styleguides +[nord-contrib-guide-versioning]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#versioning +[nord-contrib-guide]: https://github.com/arcticicestudio/nord/blob/develop/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 diff --git a/content/docs/ports/highlightjs/installation/index.mdx b/content/docs/ports/highlightjs/installation/index.mdx new file mode 100644 index 00000000..163bf73d --- /dev/null +++ b/content/docs/ports/highlightjs/installation/index.mdx @@ -0,0 +1,76 @@ +import Link from "atoms/core/Link"; +import { Banner, Image, ShrinkedWidth, SpaceBox } from "atoms/core/mdx-elements"; +import { Code } from "atoms/core/html-elements"; +import { ReactComponent as WindowCode } from "assets/images/illustrations/window-code.svg"; +import { ROUTE_DOCS_COLOR_AND_PALETTES, ROUTE_PORTS } from "config/routes/mappings"; + +import WIPNotice from "../../../../shared/docs/wip-notice"; + +export const frontmatter = { + title: "Installation & Usage", + subline: "Get up and running in one line of code" +}; + +