diff options
author | Thibaud LeprĂȘtre <thibaud.lepretre@gmail.com> | 2017-11-02 00:25:19 +0300 |
---|---|---|
committer | Thibaud LeprĂȘtre <thibaud.lepretre@gmail.com> | 2017-11-02 00:25:19 +0300 |
commit | ae210f6b361e32c70758b432e176f0cdd92053ce (patch) | |
tree | 85f9a34a0d88f3d916ed96cfdbdf9c60fedb60b2 /docs | |
parent | 8c137dc5d3d0669c7ae6df144463d52c4949db1e (diff) |
Add prism.js support
With new syntax highlighter prism.js, you have to configure which syntax highlighter you want to use between _highlight.js_ and _prism.js_. **However if you don't configure it, no syntax highligh will be apply** (where previously _highlight.js_ was forced by default).
Please upgrade you're `config.toml` (you can checkout `exampleSite/config.toml` to see sample) to re-add _highlight.js_ as syntax highlighter (except if you don't need it):
```toml
[params]
syntaxHighlighter = "highligth.js"
```
fixes #24
Diffstat (limited to 'docs')
-rw-r--r-- | docs/user.md | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/docs/user.md b/docs/user.md index 31bf15d..0927d85 100644 --- a/docs/user.md +++ b/docs/user.md @@ -347,6 +347,7 @@ E.g to display a shortcut to open algolia search window : favicon = /favicon.png imageGallery = true hierarchicalCategories = true + syntaxHighlighter = 'highlight.js' ``` | Variable | Description | @@ -362,6 +363,7 @@ E.g to display a shortcut to open algolia search window : | hierarchicalCategories | Define categories will create hierarchy between parents: `categories = ["foo", "bar"]` will consider "bar" a sub-category of "foo". If false it will flat categories. | | customCSS (_DEPRECATED see [Add custom JS or CSS using configuration](#add-custom-js-or-css-using-configuration)_) | Define files with css that override or extend the theme css: `customCSS` = ["css/mystyles.css"]. | | customJS (_DEPRECATED see [Add custom JS or CSS using configuration](#add-custom-js-or-css-using-configuration)_) | Define files with js that override or extend the theme js: `customJS` = ["js/myscripts.js"]. | +| syntaxHighlighter | Define which syntax highlighter you want to use (if not set syntax highlighting is disable) between `highlight.js` and `prism.js` | E.g : A category page look like this with `hierarchicalCategories = true` : @@ -497,7 +499,7 @@ Follow these steps, to add new filter : ### Prerequisites -Since you are going to edit the theme, you have to install all the necessary to build it after changes : [Installation](https://github.com/LouisBarranqueiro/hexo-theme-tranquilpeak/blob/master/docs/developer.md#installation) +Since you are going to edit the theme, you have to install all the necessary to build it after changes : [Installation](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/docs/developer.md#installation) **Run command in theme folder : `hexo-blog/themes/tranquilpeak`** @@ -513,7 +515,7 @@ Of course, you can replace it with an other theme found on highlight.js reposito Follow these steps : 1. Get your theme here : [Highlight.js theme](https://github.com/isagalaev/highlight.js/tree/master/src/styles) or create yours -2. Follow guidelines in `source/scss/themes/hljs-custom.scss` file +2. Follow guidelines in `src/scss/themes/hljs-custom.scss` file 3. Build the theme with `npm run prod` or `grunt buildProd`. Learn more about Grunt tasks : [Grunt tasks](https://github.com/LouisBarranqueiro/hexo-theme-tranquilpeak/blob/master/docs/developer.md#grunt-tasks) ## Writing posts |