Lightweight, robust, elegant syntax highlighting.
Go to file
Prayag Verma 69cbf7a26f Fixing to initial copyright year
According to http://www.copyright.gov/circs/circ01.pdf , listing the first year of publication in the copyright is enough
2016-01-18 21:53:13 +05:30
components Update auto-generated files 2016-01-17 13:56:32 +01:00
examples Merge pull request #814 from Golmote/prism-kotlin 2015-10-26 08:16:29 +01:00
img Reduce size of image for U.S. Web Design Standards on homepage. (#785) 2015-10-14 07:56:35 +02:00
plugins Merge pull request #845 from chriswells0/command-line 2016-01-02 14:33:53 +02:00
templates Added @Golmote to the footer. 2015-10-13 15:47:43 -04:00
tests Use child processes to run each set of tests, in order to deal with the memory leak in vm.runInNewContext() 2015-10-26 22:26:05 +01:00
themes revert white-space to normal when code is inline instead of in a pre 2015-10-28 10:21:41 -04:00
vendor Added recursive dependency loader for test page 2014-08-13 16:40:25 +02:00
.editorconfig Added basic .editorconfig 2015-09-27 10:04:21 +02:00
.gitattributes Add .gitattributes to prevent line ending changes in test files 2015-08-18 08:17:01 +02:00
.gitignore Add .DS_Store in .gitignore 2015-06-12 20:33:36 +02:00
.npmignore Added .npmignore 2014-04-21 14:46:07 +01:00
.travis.yml Added travis.yml to run tests in travis 2015-07-26 14:32:00 +02:00
CHANGELOG.md Release 1.3.0 2015-10-26 22:36:04 +01:00
CNAME Added CNAME file 2012-07-31 11:59:25 +12:00
LICENSE Fixing to initial copyright year 2016-01-18 21:53:13 +05:30
README.md Update README.md 2015-08-18 23:54:14 +02:00
bower.json Update bower.json 2015-06-18 21:24:43 -07:00
code.js Fix broken heading links. 2015-12-30 18:36:44 +08:00
components.js Remove default option for JSON language 2016-01-05 19:09:28 +01:00
download.html Merge pull request #561 from Golmote/prism-check-all 2015-09-03 22:54:45 +02:00
download.js Fixed components order. In case if one component requires other, the required component should go first. Now components are sorted regarding their requirements. 2015-10-07 00:29:05 -04:00
examples.html Added some language aliases. 2015-09-03 23:39:16 +02:00
examples.js Fixed repository url in examples 2015-02-25 12:24:48 +01:00
extending.html Updated documentation since the example was not relevant any more 2015-08-26 14:49:26 +02:00
faq.html Moved themes to themes/ folder 2013-10-07 09:46:33 +02:00
favicon.png Added favicon 2012-07-31 18:38:02 +12:00
gulpfile.js Update changelog 2015-10-26 22:34:58 +01:00
index.html Use screenshot instead of text logo for U.S. Web Design Standards on homepage. (#785) 2015-10-14 07:53:41 +02:00
logo.svg Optimised logo a bit ;) 2012-08-30 17:45:18 +10:00
package.json Release 1.3.0 2015-10-26 22:36:04 +01:00
prefixfree.min.js Styling and docs changes 2012-07-31 18:14:55 +12:00
prism.js Update auto-generated files 2016-01-17 13:56:32 +01:00
style.css Use screenshot instead of text logo for U.S. Web Design Standards on homepage. (#785) 2015-10-14 07:53:41 +02:00
test-suite.html Test runner: Allow to run tests for only some languages 2015-10-06 08:25:54 +02:00
test.html Improve test drive page usability. Fix #591 2015-06-12 21:43:31 +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!!