prismjs
Advanced tools
Package description
PrismJS is a lightweight, extensible syntax highlighter, built with modern web standards in mind. It's used to make code snippets in web pages prettier and more readable. It supports a wide range of programming languages and comes with a variety of themes.
Syntax Highlighting
This feature allows you to highlight syntax of various programming languages. The code sample demonstrates how to highlight JavaScript code using PrismJS.
Prism.highlight(code, Prism.languages.javascript, 'javascript');Extensible Language Definitions
PrismJS allows you to extend existing language definitions to add new patterns or modify existing ones. The code sample shows how to add a new pattern to the JavaScript language definition.
Prism.languages.insertBefore('javascript', 'function-variable', {
'function-variable': {
pattern: /\bvar\s+[a-z0-9_]+\s*=\s*function\b/,
alias: 'function'
}
});Custom Hooks
You can add custom hooks to modify code or the environment before or after the highlighting process. The code sample demonstrates a hook that replaces occurrences of 'foo' with 'bar' before highlighting.
Prism.hooks.add('before-highlight', function(env) {
env.code = env.element.textContent.replace(/\bfoo\b/g, 'bar');
});Themes
PrismJS comes with a variety of themes that can be easily included in your web page to change the appearance of highlighted code. The code sample shows how to include a PrismJS theme in an HTML document.
<link href="themes/prism.css" rel="stylesheet" />Plugins
PrismJS supports plugins that add additional functionality, such as displaying line numbers. The code sample demonstrates how to include the line numbers plugin.
<script src="plugins/line-numbers/prism-line-numbers.js"></script>Highlight.js is another popular syntax highlighter that is often compared to PrismJS. It supports more languages out of the box and is used by many projects. However, it is larger in size compared to PrismJS, which aims to be lightweight.
SHJS is a JavaScript syntax highlighting engine that can highlight source code in HTML documents. It is less popular and not as actively maintained as PrismJS, and it has a smaller community and fewer features.
Rainbow is a small, fast, and customizable option for syntax highlighting. It is similar to PrismJS in terms of goals and size, but it has a different plugin system and fewer languages supported by default.
SyntaxHighlighter is a fully functional self-contained code syntax highlighter developed in JavaScript. It is one of the older options available and offers a wide range of themes and brushes (language definitions), but it is bulkier compared to PrismJS.
Changelog
1.19.0 (2020-01-13)
Readme
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?
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:
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. The minified files are also generated automatically.prism.js. Having gulp installed, you just need to run the command gulp.components.json as well and rebuild Prism by running gulp, 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.Thank you so much for contributing!!
FAQs
Lightweight, robust, elegant syntax highlighting. A spin-off project from Dabblet.
We found that prismjs demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 8 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
LDAPjs, an LDAP Client and Server API for Node.js, was decommissioned after its maintainer received an abusive email from a user, raising concerns about this form of abuse as a potential attack vector.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.