Lightweight, robust, elegant syntax highlighting.
Go to file
Valtteri Laitinen e63d159729 Set default indentation size (#1516)
Updates the .editorconfig to display tabs as four spaces.
2018-08-19 10:56:44 -04:00
components Added support for quote escapes to SQL strings (#1500) 2018-08-19 10:47:52 -04:00
examples Remove extraneous class 2018-06-26 11:32:31 -04:00
img Update "Used by" section (#1330) 2018-03-07 21:31:53 +01:00
plugins Added missing aliases to components.json (#1503) 2018-08-19 10:50:41 -04:00
templates Use HTTPS / canonical URLs (#1390) 2018-04-17 00:28:42 +02:00
tests Added support for quote escapes to SQL strings (#1500) 2018-08-19 10:47:52 -04:00
themes Correct typo (#1508) 2018-08-19 10:55:06 -04:00
vendor Add a way to download all grammars as a Zip directly from the Autoloader plugin page 2016-06-18 15:45:25 +02:00
.editorconfig Set default indentation size (#1516) 2018-08-19 10:56:44 -04:00
.gitattributes Add .gitattributes to prevent line ending changes in test files 2015-08-18 08:17:01 +02:00
.gitignore add Io syntax (#1251) 2018-01-02 08:58:10 +01:00
.npmignore Update .npmignore Close #1274 2018-03-20 09:00:58 +01:00
.travis.yml Build all branches (including gh-pages) on Travis CI. Closes #1341 2018-03-11 09:26:33 +01:00
CHANGELOG.md Linkify changelog more + add missing PR references 2018-07-06 22:52:36 +02:00
CNAME Create CNAME 2018-05-31 12:20:19 +03:00
LICENSE Fixing to initial copyright year 2016-01-18 21:53:13 +05:30
README.md Add Chinese translation 2018-06-11 21:11:23 -04:00
bower.json Ignore tests directory in bower.json 2016-04-06 03:56:45 +02:00
code.js Website: Check stored theme by default + link both theme selectors together. Close #1038 2018-03-20 08:27:50 +01:00
components.js Added missing aliases to components.json (#1503) 2018-08-19 10:50:41 -04:00
components.json Added missing aliases to components.json (#1503) 2018-08-19 10:50:41 -04:00
composer.json Add Composer support (#648) 2017-09-09 11:15:47 +02:00
download.html Improve download page typography (#1484) 2018-07-21 15:48:45 -04:00
download.js Fixed peer dependencies in download page (#1491) 2018-07-21 23:47:02 -04:00
examples.html Use rel="icon" instead of rel="shortcut icon" (#1398) 2018-04-22 14:55:38 +02:00
examples.js Website: Auto-generate example header with component title, list of aliases and dependencies. 2018-03-11 11:11:34 +01:00
extending.html Fixed empty link in extending (#1507) 2018-08-19 10:54:25 -04:00
faq.html Use rel="icon" instead of rel="shortcut icon" (#1398) 2018-04-22 14:55:38 +02:00
favicon.png Optimize images (#1007) 2016-07-29 13:37:25 -04:00
gulpfile.js Gulp: There is probably no need to minify `components/index.js` 2018-04-05 19:08:57 +02:00
index.html Updated index.html to fix broken instructions (#1462) 2018-07-06 22:48:04 +02:00
logo.svg Website: remove width and height on logo.svg, so it becomes scalable. Close #1005 2017-09-09 12:12:00 +02:00
package.json 1.15.0 2018-06-16 21:48:52 -04:00
prefixfree.min.js Styling and docs changes 2012-07-31 18:14:55 +12:00
prism.js Fix regex for `catch` and `finally` (#1527) 2018-08-19 10:06:34 -04:00
style.css Fix mixed content warning 2018-05-31 12:26:07 +03:00
test-suite.html Use rel="icon" instead of rel="shortcut icon" (#1398) 2018-04-22 14:55:38 +02:00
test.html Use rel="icon" instead of rel="shortcut icon" (#1398) 2018-04-22 14:55:38 +02:00
utopia.js Commit updated line changes 2015-08-18 08:22:40 +02:00

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, its 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!!

Translations

  • 中文说明