aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHakim El Hattab <hakim.elhattab@gmail.com>2017-11-09 11:48:51 +0100
committerGitHub <noreply@github.com>2017-11-09 11:48:51 +0100
commit9d0a3d7d5ef46f1841fdd4e8f0397b9c311f50b0 (patch)
treec9734a616ccb0cb16aeadf04925e86abcad85f78
parent41e86a2a22558af90d685c2db8c01677080310a7 (diff)
parent665d3a151db2521922f51fee250f0511ffa03be7 (diff)
downloadfosdem-2018-presentation-9d0a3d7d5ef46f1841fdd4e8f0397b9c311f50b0.tar
fosdem-2018-presentation-9d0a3d7d5ef46f1841fdd4e8f0397b9c311f50b0.tar.gz
Merge pull request #1983 from ssfrr/patch-1
adds note about necessary markdown scripts to README
-rw-r--r--README.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/README.md b/README.md
index 0c017db..d164a65 100644
--- a/README.md
+++ b/README.md
@@ -105,7 +105,7 @@ The presentation markup hierarchy needs to be `.reveal > .slides > section` wher
### Markdown
-It's possible to write your slides using Markdown. To enable Markdown, add the `data-markdown` attribute to your `<section>` elements and wrap the contents in a `<textarea data-template>` like the example below.
+It's possible to write your slides using Markdown. To enable Markdown, add the `data-markdown` attribute to your `<section>` elements and wrap the contents in a `<textarea data-template>` like the example below. You'll also need to add the `plugin/markdown/marked.js` and `plugin/markdown/markdown.js` scripts (in that order) to your HTML file.
This is based on [data-markdown](https://gist.github.com/1343518) from [Paul Irish](https://github.com/paulirish) modified to use [marked](https://github.com/chjj/marked) to support [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown). Sensitive to indentation (avoid mixing tabs and spaces) and line breaks (avoid consecutive breaks).