Github url

prism

by PrismJS

PrismJS /prism

Lightweight, robust, elegant syntax highlighting.

8.1K Stars 964 Forks Last release: 3 months ago (v1.20.0) MIT License 3.0K Commits 31 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Prism

Build Statusnpm

Prism is a lightweight, robust, 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!

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.
    prism.js
    and all minified files are also generated automatically by our build system.
  • 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 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 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!!

Translations

  • 中文说明

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.