gitbook-plugin-prism

Prism highlighting for gitbook

Apache-2.0 14 个版本
主页
仓库
提交 Issue
安装
npm install gitbook-plugin-prism
yarn add gitbook-plugin-prism
pnpm add gitbook-plugin-prism
bun add gitbook-plugin-prism
README

Gitbook Plugin for Prism

NPM

Before
After

Usage

Add the plugin to your book.json, and disable default GitBook code highlighting:

{
  "plugins": ["prism", "-highlight"]
}

Options

css

Override default styles. All css files must reside in the same folder.

"pluginsConfig": {
  "prism": {
    "css": [
      "prismjs/themes/prism-solarizedlight.css"
    ]
  }
}

lang

Support non-standard syntax prefixes by aliasing existing prefixes.

"pluginsConfig": {
  "prism": {
    "lang": {
      "flow": "typescript"
    }
  }
}

ignore

Due to other plugins using code block notion to denote other functionality, you can ignore certain langs

"pluginsConfig": {
  "prism": {
    "ignore": [
      "mermaid",
      "eval-js"
    ]
  }
}

Prism Themes

https://github.com/PrismJS/prism

Okaidia prismjs/themes/prism-okaidia.css

Okaidia

Solarized Light prismjs/themes/prism-solarizedlight.css

Solarized Light

Tomorrow prismjs/themes/prism-tomorrow.css

Tomorrow

Dark prismjs/themes/prism-dark.css

Dark

Coy prismjs/themes/prism-coy.css

Coy

Atelierbram Themes

https://github.com/atelierbram/syntax-highlighting

Base16 Ocean Dark syntax-highlighting/assets/css/prism/prism-base16-ocean.dark.css

Base16 Ocean Dark

Google Light syntax-highlighting/assets/css/prism/prism-base16-google.light.css

Google Light

Xonokai syntax-highlighting/assets/css/prism/prism-xonokai.css

Google Light

Credits

Originally based on https://github.com/spricity/google_code_prettify.

License

Apache 2

版本列表
2.4.0 2018-07-26
2.3.0 2017-08-26
2.2.1 2017-07-09
2.2.0 2017-03-10
2.1.0 2017-01-31
2.0.3 2017-01-28
2.0.2 2017-01-08
2.0.1 2016-11-30
2.0.0 2016-11-19
1.1.0 2016-09-03
1.0.0 2015-10-05
0.1.1 2015-09-12
0.1.0 2015-09-12
0.0.1 2015-09-12