aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBenjamin Tan <demoneaux@gmail.com>2016-12-08 17:41:55 +0800
committerBenjamin Tan <demoneaux@gmail.com>2016-12-08 17:41:55 +0800
commit90b301d0a03b8b23ce755c31ec6dac15cf69dc49 (patch)
tree6079937a9f78770c1bf291da38716782f0ac6e5a /README.md
parent2bd6b563be65bb0ff95593b30572ca72fd3e8b77 (diff)
downloadfosdem-2018-presentation-90b301d0a03b8b23ce755c31ec6dac15cf69dc49.tar
fosdem-2018-presentation-90b301d0a03b8b23ce755c31ec6dac15cf69dc49.tar.gz
Enable passing options for parsing Markdown.
Closes #1163, #1495.
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
index b0257cc..1c55623 100644
--- a/README.md
+++ b/README.md
@@ -160,6 +160,18 @@ Special syntax (in html comment) is available for adding attributes to the slide
</section>
```
+#### Configuring `marked`
+
+We use [marked](https://github.com/chjj/marked) to parse Markdown. To customise marked's rendering, you can pass in options when [configuring Reveal](#configuration):
+
+```javascript
+Reveal.initialize({
+ // Options which are passed into marked
+ // See https://github.com/chjj/marked#options-1
+ markdown: {
+ smartypants: true
+ }
+});
### Configuration