# syntaxhighlighter

> [![GratiPay](https://img.shields.io/gratipay/user/alexgorbatchev.svg)](https://gratipay.com/alexgorbatchev/) [![Build Status](https://travis-ci.org/syntaxhighlighter/theme-swift.svg)](https://travis-ci.org/syntaxhighlighter/syntaxhighlighter) ![Downloads]

Latest version **4.0.1** (published 2016-02-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install syntaxhighlighter
pnpm add syntaxhighlighter
yarn add syntaxhighlighter
bun add syntaxhighlighter
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.0.1 |
| Published | 2016-02-20 |
| First published | 2014-01-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5299 |
| Author | Alex Gorbatchev |
| Maintainers | alexgorbatchev |

## Links

- npm: https://www.npmjs.com/package/syntaxhighlighter
- Repository: https://github.com/syntaxhighlighter/syntaxhighlighter
- Homepage: https://github.com/syntaxhighlighter/syntaxhighlighter#readme
- Issues: https://github.com/syntaxhighlighter/syntaxhighlighter/issues
- npm.io page: https://npm.io/package/syntaxhighlighter

## Dependencies (8)

- [domready](https://npm.io/package/domready.md) ^1.0.5
- [retabber](https://npm.io/package/retabber.md) ^4.0.0
- [brush-base](https://npm.io/package/brush-base.md) ^4.0.0
- [unindenter](https://npm.io/package/unindenter.md) ^4.0.0
- [opts-parser](https://npm.io/package/opts-parser.md) ^4.0.0
- [syntaxhighlighter-match](https://npm.io/package/syntaxhighlighter-match.md) ^4.0.0
- [syntaxhighlighter-regex](https://npm.io/package/syntaxhighlighter-regex.md) ^4.0.0
- [syntaxhighlighter-html-renderer](https://npm.io/package/syntaxhighlighter-html-renderer.md) ^4.0.0

## Recent versions

- 4.0.1 (latest) — 2016-02-20
- 3.0.90 — 2016-02-12
- 4.0.0 — 2016-02-12
- 4.0.0-alpha — 2014-01-18

## README

# SyntaxHighlighter v4

[![GratiPay](https://img.shields.io/gratipay/user/alexgorbatchev.svg)](https://gratipay.com/alexgorbatchev/)
[![Build Status](https://travis-ci.org/syntaxhighlighter/theme-swift.svg)](https://travis-ci.org/syntaxhighlighter/syntaxhighlighter)
![Downloads](https://img.shields.io/npm/dm/syntaxhighlighter.svg)
![Version](https://img.shields.io/npm/v/syntaxhighlighter.svg)

SyntaxHighlighter is THE client side highlighter for the web and web-apps! It's been around since 2004 and it's used virtually everywhere to seamlessly highlight code for presentation purposes.

<img src="screenshot.png" width="640"/>

The history of this project predates majority of the common web technologies and it has been a challenge to dedicate time and effort to keep it up to date. Everything used to be in one file and assign `window` variables... Horrors!

SyntaxHighlighter is currently used and has been used in the past by Microsoft, Apache, Mozilla, Yahoo, Wordpress, Bug Labs, Freshbooks and many many other companies and blogs.

## :zap: Reporting an issue? See [Filing Issues]. :zap:

## Get Started

* [Building] instructions
* [Usage] instructions
* Be sure to read the [Caveats]

## FAQ

* v4 is fully compatible with old brushes and themes, see [Building] instructions.
* The `?` was completely removed for cleaner, more seamless experience.
* You still have to HTML escape `<` when using `<pre/>` tags.

## Older Version

If you are looking for v3 documentation and download, you can find it on the [old site](alexgorbatchev.com/SyntaxHighlighter).

# Support

As it always goes with open source, you are welcome to use SyntaxHighlighter free of charge. If you are using and enjoying my work, maybe you could buy me a beer (or if you don’t drink – a coffee and bagel will do just fine, a good kind of bagel though, you know… with wonderful stuff inside to make it glorious, like smoked salmon and creamcheese… not just butter).

**Please [click here to donate via PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=2930402) and just like they say on TV – give generously! It motivates me to keep working on this (12 years now and counting).**

# License

MIT

[Filing Issues]: https://github.com/syntaxhighlighter/syntaxhighlighter/wiki/Filing-Issues
[Building]: https://github.com/syntaxhighlighter/syntaxhighlighter/wiki/Building
[Usage]: https://github.com/syntaxhighlighter/syntaxhighlighter/wiki/Usage
[Caveats]: https://github.com/syntaxhighlighter/syntaxhighlighter/wiki/Caveats

---
_Source: https://npm.io/package/syntaxhighlighter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
