prism README

The project's README from github.com/PrismJS/prism. As one markdown file: README.md.

Prism

Build Status npm

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

You can learn more on prismjs.com.

Why another syntax highlighter?

More themes for Prism!

Contribute to Prism!

Important Notice

We are currently working on Prism 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 our Discussion page and mentioned in the roadmap 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 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. prism.js and all minified files are generated by our build system (see below).
  • Use npm ci to install Prism's dependencies. Do not use npm install because it will cause non-deterministic builds.
  • The build system uses gulp to minify the files and build prism.js. With all of Prism's dependencies installed, you just need to run the command npm run build.
  • 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 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 you add a new language definition or plugin, you need to add it to components.json as well and rebuild Prism by running npm run build, so that it becomes available to the download build page. For new languages, please also add a few tests and an example in the examples/ folder.
  • Go to prism-themes if you want to add a new theme.

Thank you so much for contributing!!

Software requirements

Prism will run on almost any browser and Node.js version but you need the following software to contribute:

  • Node.js >= 10.x
  • npm >= 6.x

Translations

prism (PrismJS/prism)

Searching Database…

13.1K ·GitHub
Prism
What is this?Prism is a lightweight, robust, and elegant syntax highlighting library for the web — a spin-off project from Dabblet.
Is it something I add to my web page, or a tool I run separately?It's a JavaScript library, not a standalone app: Prism runs in almost any browser or Node.js version, so you include it on your page and it highlights code right there.
How do I get it onto my site?Build a custom bundle on the download page at prismjs.com, choosing exactly the languages and plugins you need, or install the prismjs package from npm.
What do I need installed, both to use it and to work on it?Nothing to use it — Prism has zero runtime dependencies and runs in almost any browser. To contribute you need Node.js >= 10.x and npm >= 6.x, and you must install dependencies with npm ci, because npm install causes non-deterministic builds.
Why another syntax highlighter?The README poses that very question, and its short answer starts with: more themes. Prism is designed to be extensible, so languages and plugins are separate components you pick from when building your bundle.
Which languages can it highlight out of the box?A wide set — language definitions ship as separate components, coverage grows through community contributions, and the download page lets you include exactly the ones you need.
How do I add support for a brand-new language?Add the unminified definition to the components/ folder, register it in components.json, and run npm run build so it appears on the download page. Include a few tests and an example too — and note you become responsible for bug reports about your language definition.
Can I create my own color theme?Yes — new themes belong in the separate prism-themes repository rather than the main Prism repo.
What are similar projects?classnames, microlighter, validator.js, lollipop-css, tween.js, uPlot, twinkleplop, ace
Which topics is it in?zero-dependency, syntax-highlighting, plugins, themes, npm-package, lightweight, javascript-library, browser, web-development, free, npm, frontend
Creator
PrismJS
Size
14.7 MB
Stars
13.1K
Updated
CommitOct 15Releasev1.30.0Mar 10
Age
14y
Commits · 90 Days