code.language-xxxx
), done!
.comment
, .string
, .property
etc
Prism is used on several websites, small and large. Some of them are:
The Prism source, highlighted with Prism (don’t you just love how meta this is?):
This page’s CSS code, highlighted with Prism:
This page’s HTML, highlighted with Prism:
This page’s logo (SVG), highlighted with Prism:
If you’re still not sold, you can view more examples or try it out for yourself.
<pre>
(on its own) or <script>
.
Prism forces you to use the correct element for marking up code: <code>
.
On its own for inline code, or inside a <pre>
for blocks of code.
In addition, the language is defined through the way recommended in the HTML5 draft: through a language-xxxx
class.You will need to include the prism.css
and prism.js
files you downloaded in your page. Example:
<!DOCTYPE html> <html> <head> ...
<link href="themes/prism.css" rel="stylesheet" />
</head> <body> ...
<script src="prism.js"></script>
</body> </html>
Prism does its best to encourage good authoring practices. Therefore, it only works with <code>
elements, since marking up code without a <code>
element is semantically invalid.
According to the HTML5 spec, the recommended way to define a code language is a language-xxxx
class, which is what Prism uses.
Alternatively, Prism also supports a shorter version: lang-xxxx
.
To make things easier however, Prism assumes that this language definition is inherited. Therefore, if multiple <code>
elements have the same language, you can add the language-xxxx
class on one of their common ancestors.
This way, you can also define a document-wide default language, by adding a language-xxxx
class on the <body>
or <html>
element.
If you want to opt-out of highlighting for a <code>
element that is a descendant of an element with a declared code language, you can add the class language-none
to it (or any non-existing language, really).
The recommended way to mark up a code block
(both for semantics and for Prism) is a <pre>
element with a <code>
element inside, like so:
<pre><code class="language-css">p { color: red }</code></pre>
If you use that pattern, the <pre>
will automatically get the language-xxxx
class (if it doesn’t already have it) and will be styled as a code block.
If you want to prevent any elements from being automatically highlighted, you can use the attribute data-manual
on the <script>
element you used for prism and use the API.
Example:
<script src="prism.js" data-manual></script>
If you want to use Prism with a bundler, install Prism with npm
:
$ npm install prismjs
You can then import
into your bundle:
import Prism from 'prismjs';
To make it easy to configure your Prism instance with only the languages and plugins you need, use the babel plugin, babel-plugin-prismjs. This will allow you to load the minimum number of languages and plugins to satisfy your needs. See that plugin's documentation for configuration details.
If you want to use Prism on the server or through the command line, Prism can be used with Node.js as well. This might be useful if you're trying to generate static HTML pages with highlighted code for environments that don't support browser-side JS, like AMP pages.
Example:
var Prism = require('prismjs');
// The code snippet you want to highlight, as a string
var code = "var data = 1;";
// Returns a highlighted HTML string
var html = Prism.highlight(code, Prism.languages.javascript, 'javascript');
Requiring prismjs
will load the default languages: markup
, css
,
clike
and javascript
. You can load more languages with the
loadLanguages()
utility, which will automatically handle any required dependencies.
Example:
var Prism = require('prismjs');
var loadLanguages = require('prismjs/components/');
loadLanguages(['haml']);
// The code snippet you want to highlight, as a string
var code = "= ['hi', 'there', 'reader!'].join \" \"";
// Returns a highlighted HTML string
var html = Prism.highlight(code, Prism.languages.haml, 'haml');
Note: Do not use loadLanguages()
with Webpack or another bundler, as this will cause Webpack to include all languages and plugins. Use the babel plugin described above.
This is the list of all languages currently supported by Prism, with
their corresponding alias, to use in place of xxxx
in the language-xxxx
(or lang-xxxx
) class:
Plugins are additional scripts (and CSS code) that extend Prism’s functionality. Many of the following plugins are official, but are released as plugins to keep the Prism Core small for those who don’t need the extra functionality.
No assembly required to use them. Just select them in the download page.
It’s very easy to write your own Prism plugins. Did you write a plugin for Prism that you want added to this list? Send a pull request!
Several tutorials have been written by members of the community to help you integrate Prism into multiple different website types and configurations:
Please note that the tutorials listed here are not verified to contain correct information. Read at your risk and always check the official documentation here if something doesn’t work :)
Have you written a tutorial about Prism that’s not already included here? Send a pull request!