Awesome Open Source
Awesome Open Source

babel-plugin-prismjs Build Status

A babel plugin to use PrismJS with standard bundlers.

How to Use

This plugin allows you to treat PrismJS as a standard module and configure what languages, plugins, & themes you want to bundle with Prism.

In your code, import prismjs:

import Prism from 'prismjs';

Prism.highlightAll();

The exported Prism object will be the fully-configured Prism instance.

Limitations

  • You must be using ES6 imports to load PrismJS.

Configuring the plugin

In your .babelrc, register the plugin and configure its dependencies:

{
  "plugins": [
    ["prismjs", {
        "languages": ["javascript", "css", "markup"],
        "plugins": ["line-numbers"],
        "theme": "twilight",
        "css": true
    }]
  ]
}

Each key are used as follows:

  • languages: Array of languages to include in the bundle. Those languages can be found here.
  • plugins: Array of plugins to include in the bundle. Those plugins can be found here.
  • theme: Name of theme to include in the bundle. Themes can be found here. Use lower-kebab-case for the theme name, e.g. solarized-light.
  • css: Boolean indicating whether to include .css files in the result. Defaults to false. If true, imports will be added for .css files. Must be true in order for theme to work.

Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
javascript (70,316
webpack (1,156
babel (356
syntax-highlighting (169
rollup (81
babel-plugin (77
browserify (49