aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBenjamin Tan <demoneaux@gmail.com>2018-02-06 22:34:25 +0800
committerBenjamin Tan <demoneaux@gmail.com>2018-02-06 22:34:25 +0800
commit410f7767b9c96c330a1b62d35acbee666021e6ad (patch)
tree0db2b2098e8db58fb7827e1c792be68b374b5b22 /README.md
parent57a4c45cf69b11cb58304085b84ce3b095fb3077 (diff)
downloadfreenode-live-2017-presentation-410f7767b9c96c330a1b62d35acbee666021e6ad.tar
freenode-live-2017-presentation-410f7767b9c96c330a1b62d35acbee666021e6ad.tar.gz
Docs: mention that syntax highlighting requires CSS theme file.
Closes #2075.
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/README.md b/README.md
index 563b305..fb93b7e 100644
--- a/README.md
+++ b/README.md
@@ -765,7 +765,9 @@ Reveal.addEventListener( 'fragmenthidden', function( event ) {
### Code syntax highlighting
-By default, Reveal is configured with [highlight.js](https://highlightjs.org/) for code syntax highlighting. Below is an example with clojure code that will be syntax highlighted. When the `data-trim` attribute is present, surrounding whitespace is automatically removed. HTML will be escaped by default. To avoid this, for example if you are using `<mark>` to call out a line of code, add the `data-noescape` attribute to the `<code>` element.
+By default, Reveal is configured with [highlight.js](https://highlightjs.org/) for code syntax highlighting. To enable syntax highlighting, you'll have to load the highlight plugin ([plugin/highlight/highlight.js](plugin/highlight/highlight.js)) and a highlight.js CSS theme (Reveal comes packaged with the zenburn theme: [lib/css/zenburn.css](lib/css/zenburn.css)).
+
+Below is an example with clojure code that will be syntax highlighted. When the `data-trim` attribute is present, surrounding whitespace is automatically removed. HTML will be escaped by default. To avoid this, for example if you are using `<mark>` to call out a line of code, add the `data-noescape` attribute to the `<code>` element.
```html
<section>