Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Lightweight, robust, elegant syntax highlighting.
JavaScript HTML CSS Shell
Branch: gh-pages
Failed to load latest commit information.
components Smarty: Optimized regexps + fixed punctuation and operators
examples Makefile example: Add known failures
img Adding CSS-Tricks logo
plugins Fix computation of line numbers for single-line code blocks. Fix #721
templates Added twitter link to footer, minified some files
tests Merge pull request #714 from Golmote/tests-java
themes Issue 324 - Fixing word wrap on long code lines, which is breaking th…
vendor Added recursive dependency loader for test page
.gitattributes Add .gitattributes to prevent line ending changes in test files
.gitignore Add .DS_Store in .gitignore
.npmignore Added .npmignore
.travis.yml Added travis.yml to run tests in travis
CNAME Added CNAME file
LICENSE add license file
README.md Update README.md
bower.json Update bower.json
code.js Fix ToC generator to work with base
components.js Sass: Add missing require in components
download.html Split plugins into 3 columns on Download page
download.js Fixed repository url on download page
examples.html Reorder languages in components.js (Fix #441)
examples.js Fixed repository url in examples
extending.html Updated documentation since the example was not relevant any more
faq.html Moved themes to themes/ folder
favicon.png Added favicon
gulpfile.js Add gulp task to build languages map in Show language plugin (Fix #671)
index.html Change the link to my article to correct URL.
logo.svg Optimised logo a bit ;)
package.json Add gulp task to build languages map in Show language plugin (Fix #671)
prefixfree.min.js Styling and docs changes
prism.js Markup: Don't allow = to appear in tag name
style.css List of supported languages on homepage
test-suite.html Drastically increased the number of dashes (from 4 to 10) required fo…
test.html Improve test drive page usability. Fix #591
utopia.js Commit updated line changes

README.md

Prism

Prism is a lightweight, robust, elegant syntax highlighting library. It's a spin-off project from Dabblet.

You can learn more on http://prismjs.com/.

Why another syntax highlighter?: http://lea.verou.me/2012/07/introducing-prism-an-awesome-new-syntax-highlighter/#more-1841

Contribute to Prism!

Prism depends on community contributions to expand and cover a wider array of use cases. If you like it, considering giving back by sending a pull request. Here are a few tips:

  • Read the documentation. Prism was designed to be extensible.
  • Do not edit prism.js, it’s just the version of Prism used by the Prism website and is built automatically. Limit your changes to the unminified files in the components/ folder. The minified files are also generated automatically.
  • The build system uses gulp to minify the files and build prism.js. Having gulp installed, you just need to run the command gulp.
  • Please follow the code conventions used in the files already. For example, I use tabs for indentation and spaces for alignment. Opening braces are on the same line, closing braces on their own line regardless of construct. There is a space before the opening brace. etc etc.
  • Please try to err towards more smaller PRs rather than few huge PRs. If a PR includes changes I want to merge and changes I don't, handling it becomes difficult.
  • My time is very limited these days, so it might take a long time to review longer PRs (short ones are usually merged very quickly), especially those modifying the Prism Core. This doesn't mean your PR is rejected.
  • If you contribute a new language definition, you will be responsible for handling bug reports about that language definition.
  • If you add a new language definition, theme or plugin, you need to add it to components.js as well, so that it becomes available to the download build page.

Thank you so much for contributing!!

Something went wrong with that request. Please try again.