David A. Windham
david
/
gitbook-plugin-prism-dw
1
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki

gitbook plugin [updated pkgs] https://github.com/windhamdavid/gitbook-plugin-prism-dw

Branch: master
Branches Tags
gitbook-plug...
windhamdavid 6a649dd161 dep up 5 years ago
.eslintrc a97ccd23d0 Fixes #9: Theme not correclty applied to code blocks 9 years ago
.gitignore a97ccd23d0 Fixes #9: Theme not correclty applied to code blocks 9 years ago
.travis.yml b685c704b2 feat: upgrade prismjs to 1.15.0+ 7 years ago
LICENSE 828f3df964 Initial commit 11 years ago
README.md 9b167f755e removed comments in README 8 years ago
index.js b685c704b2 feat: upgrade prismjs to 1.15.0+ 7 years ago
package-lock.json 6a649dd161 dep up 5 years ago
package.json 6a649dd161 dep up 5 years ago
prism-ebook.css 9b3cea821d rename css file and refactor comments 9 years ago
test.js e3d28ef150 closes #24: Compatibility with Gitbook 2.x.x 8 years ago

README.md

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