# node-syntaxhighlighter > Node friendly version of Alex Gorbachev's great SyntaxHighlighter. Latest version **0.8.1** (published 2012-08-10) · 0 weekly downloads ## Install ```sh npm install node-syntaxhighlighter pnpm add node-syntaxhighlighter yarn add node-syntaxhighlighter bun add node-syntaxhighlighter ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.8.1 | | Published | 2012-08-10 | | First published | 2012-07-12 | | Weekly downloads | 0 | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 0 | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 29 | | Author | Thorsten Lorenz | | Maintainers | thlorenz | | Keywords | syntax, highlight, code | ## Links - npm: https://www.npmjs.com/package/node-syntaxhighlighter - Repository: https://github.com/thlorenz/node-syntaxhighlighter - npm.io page: https://npm.io/package/node-syntaxhighlighter ## Alternatives - [@oh-my-pi/pi-natives](https://npm.io/package/@oh-my-pi/pi-natives.md) — 51.8K weekly downloads - [@capgo/capacitor-light-sensor](https://npm.io/package/@capgo/capacitor-light-sensor.md) — 3.0K weekly downloads - [@heyhuynhgiabuu/pi-diff](https://npm.io/package/@heyhuynhgiabuu/pi-diff.md) — 492 weekly downloads - [@lotsa/verdant-lang-asm](https://npm.io/package/@lotsa/verdant-lang-asm.md) — 38 weekly downloads - [new-era-syntax](https://npm.io/package/new-era-syntax.md) — 20 weekly downloads ## Recent versions - 0.8.1 (latest) — 2012-08-10 - 0.8.0 — 2012-07-21 - 0.7.4 — 2012-07-19 - 0.7.3 — 2012-07-18 - 0.7.2 — 2012-07-17 - 0.7.0 — 2012-07-16 - 0.6.0 — 2012-07-15 - 0.5.0 — 2012-07-14 - 0.4.1 — 2012-07-14 - 0.4.0 — 2012-07-13 - 0.3.0 — 2012-07-13 - 0.1.83 — 2012-07-13 - 0.0.83 — 2012-07-12 ## README # node-syntaxhighlighter [![Build Status](https://secure.travis-ci.org/thlorenz/node-syntaxhighlighter.png)](http://travis-ci.org/thlorenz/node-syntaxhighlighter) Node friendly version of [Alex Gorbachev's great SyntaxHighlighter](http://alexgorbatchev.com/SyntaxHighlighter/). # Why Using the [current version of SyntaxHighlighter](https://github.com/alexgorbatchev/SyntaxHighlighter) with nodejs is not straight forward. Although it can be installed with npm by using the git repo url as package name, it is not obvious on how to use it with nodejs. **node-syntaxhighlighter** tries to fix that and expose a nodejs friendly api to SyntaxHighlighter. # Example ```javascript var nsh = require('node-syntaxhighlighter') , language = nsh.getLanguage('js') , code = 'var nshRocks = true;' ; console.log( nsh.highlight(code, language) ); ``` Outputs: ```html
1
var nshRocks = true ;
``` More examples inside [examples folder](./node-syntaxhighlighter/tree/master/examples). ## Try full page example After installing the package run [pageofself](./node-syntaxhighlighter/blob/master/examples/pageofself.js) like so: ```shell npm explore node-syntaxhighlighter cd examples node pageofself ``` # API ## *getLanguage(alias, strict = false)* Resolves SyntaxHighlighter language for given alias and tries to use similar languages if strict is false. Returns that language or undefined if not found. - alias: can be any alias known to SyntaxHighlighter or a file extension, e.g.,'javascript', 'js' or '.js' - strict: if false similar languages are returned if exact match isn't found ## *highlight(code, language[, options])* Highlights given code with SyntaxHighlighter language using given options with exceptions (see below). For more information about options consult the [SyntaxHighlighter configuration page](http://alexgorbatchev.com/SyntaxHighlighter/manual/configuration/). - code: the code to highlight - language: language object obtained via ***getLanguage*** **Option Exceptions:** ***'html-script'***: - this option is ignored, since node-syntaxhighlighter will automatically find contained scripts inside html and xhtml documents - just highlight the page with ***'html'*** alias and code inside recognized script tags will be highlighted using the language specific highlighter - for more information consult the [inline script examples](./node-syntaxhighlighter/tree/master/examples/inline-scripts) and the [inline script tests](./node-syntaxhighlighter/blob/master/test/inlinescripts.js) ## *getStyles()* Returns all available styles in the following format: ```javascript { name: 'stylename', sourcePath: '/path/to/style.css' } ``` ## *copyStyle(style, targetPath, callback)* Copies the given ***style*** to the given ***target path*** as 'stylename.css' and invokes ***callback*** when finished. - style: either its name (e.g., default) or one of the style objects returned from ***getStyles()***. - targetPath: **full** path to which to copy the 'stylename.css' - callback: invoked either with null or ***Error*** if an error occurred ## *copyStyles(targetPath, callback)* Copies all available styles to the given ***target path*** as 'stylename.css' and invokes ***callback*** when finished. - targetPath: **full** path to which to copy the styles - callback: invoked either with null or ***Error*** if an error occurred # Syncing with original SyntaxHighlighter node-syntaxhighlighter includes a synchronization script which allows staying up to date with the original SyntaxHighlighter. I will run this whenever a new version of SyntaxHighlighter becomes available and the publish the updated version. The currently synced version is documented inside [package.json](./node-syntaxhighlighter/blob/master/package.json) as the "version-sync". --- _Source: https://npm.io/package/node-syntaxhighlighter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._