Skip to content

Commit

Permalink
Refactor options instructions in README
Browse files Browse the repository at this point in the history
  • Loading branch information
Rob McGuinness committed Jan 31, 2017
1 parent 8763941 commit 11ee57a
Showing 1 changed file with 16 additions and 14 deletions.
30 changes: 16 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,12 @@ Add the plugin to your `book.json`, and disable default GitBook code highlightin

## Options


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

```json
"pluginsConfig": {
"pluginsConfig": {
"prism": {
"css": [
"prismjs/themes/prism-solarizedlight.css"
Expand All @@ -33,6 +35,19 @@ Override default styles. All css files must reside in the same folder.
}
```

### `lang`
Support non-standard syntax prefixes by aliasing existing prefixes.

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

### Prism Themes

[https://github.com/PrismJS/prism](https://github.com/PrismJS/)
Expand Down Expand Up @@ -65,19 +80,6 @@ Override default styles. All css files must reside in the same folder.
#### Xonokai <small>`syntax-highlighting/assets/css/prism/prism-xonokai.css`</small>
![Google Light](http://i.imgur.com/fPjEEv8.png)

### Syntax aliasing

To support non-standard syntax prefixes, you can alias existing prefixes:
```json
"pluginsConfig": {
"prism": {
"lang": {
"flow": "typescript"
}
}
}
```

## Credits

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

0 comments on commit 11ee57a

Please sign in to comment.