Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 3,611 Commits
.github		.github
assets		assets
benchmark		benchmark
components		components
docs		docs
examples		examples
gulpfile.js		gulpfile.js
plugins		plugins
tests		tests
themes		themes
.editorconfig		.editorconfig
.eslintrc.js		.eslintrc.js
.gitattributes		.gitattributes
.gitignore		.gitignore
.jsdoc.json		.jsdoc.json
.npmignore		.npmignore
CHANGELOG.md		CHANGELOG.md
LICENSE		LICENSE
MAINTAINERS.md		MAINTAINERS.md
README.md		README.md
SECURITY.md		SECURITY.md
_headers		_headers
benchmark.html		benchmark.html
bower.json		bower.json
components.js		components.js
components.json		components.json
composer.json		composer.json
dangerfile.js		dangerfile.js
dependencies.js		dependencies.js
download.html		download.html
examples.html		examples.html
extending.html		extending.html
faq.html		faq.html
index.html		index.html
known-failures.html		known-failures.html
package-lock.json		package-lock.json
package.json		package.json
prism.js		prism.js
test-suite.html		test-suite.html
test.html		test.html
tokens.html		tokens.html

Repository files navigation

Prism

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

You can learn more onprismjs.com.

Why another syntax highlighter?

More themes for Prism!

Contribute to Prism!

Important Notice

We are currently working onPrism v2 and will only accept security-relevant PRs for the time being.

Once work on Prism v2 is sufficiently advanced, we will accept PRs again. This will be announced on ourDiscussion page and mentioned in theroadmap discussion.

Prism v1 contributing notes

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

Read thedocumentation. Prism was designed to be extensible.
Do not editprism.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 thecomponents/ folder.prism.js and all minified files are generated by our build system (see below).
Usenpm ci to install Prism's dependencies. Do not usenpm install because it will cause non-deterministic builds.
The build system usesgulp to minify the files and buildprism.js. With all of Prism's dependencies installed, you just need to run the commandnpm run build.
Please follow the code conventions used in the files already. For example, I usetabs 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 a few huge PRs. If a PR includes changes that I want to merge and also changes that I don't, handling it becomes difficult.
My time is very limited these days, so it might take a long time to review bigger PRs (small 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 youadd a new language definition or plugin, you need to add it tocomponents.json as well and rebuild Prism by runningnpm run build, so that it becomes available to the download build page. For new languages, please also add a fewtests and an example in theexamples/ folder.
Go toprism-themes if you want to add a new theme.