Enable passing options for parsing Markdown.

Closes #1163, #1495.
2016-12-08 17:41:55 +08:00
parent 2bd6b563be
commit 90b301d0a0
5 changed files with 99 additions and 14 deletions
--- 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