https://github.com/syntaxhighlighter/syntaxhighlighter

SyntaxHighlighter is a fully functional self-contained code syntax highlighter developed in JavaScript.
https://github.com/syntaxhighlighter/syntaxhighlighter

Last synced: 3 days ago
JSON representation

SyntaxHighlighter is a fully functional self-contained code syntax highlighter developed in JavaScript.

• Host: GitHub
• URL: https://github.com/syntaxhighlighter/syntaxhighlighter
• Owner: syntaxhighlighter
• License: mit
• Created: 2010-12-16T02:36:20.000Z (about 14 years ago)
• Default Branch: master
• Last Pushed: 2020-04-18T00:30:20.000Z (over 4 years ago)
• Last Synced: 2025-01-01T17:05:45.038Z (10 days ago)
• Language: JavaScript
• Homepage:
• Size: 5.8 MB
• Stars: 5,326
• Watchers: 264
• Forks: 1,274
• Open Issues: 234
• Metadata Files:
  • Readme: README.md
  • License: MIT-LICENSE

Awesome Lists containing this project

• stars - syntaxhighlighter/syntaxhighlighter - contained code syntax highlighter developed in JavaScript. (JavaScript / REST)
• awesomelist - **syntaxhighlighter** - contained code syntax highlighter developed in JavaScript. (Syntax Highlight)
• awesomelist - **syntaxhighlighter** - contained code syntax highlighter developed in JavaScript. (Syntax Highlight)

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.



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 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 `
` 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