dyndoc-ruby 0.2.0 → 0.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (466) hide show
  1. checksums.yaml +4 -4
  2. data/bin/dyn-init.rb +9 -0
  3. data/share/demo/first.dyn +38 -0
  4. data/share/demo/second.dyn +87 -0
  5. data/share/demo/simple.dyn +10 -0
  6. data/share/demo/simple_lib.dyn +2 -0
  7. data/share/demo/simple_lib2.dyn +2 -0
  8. data/share/demo/testBeamer.dyn +77 -0
  9. data/share/demo/testBeamer_lib.dyn +7 -0
  10. data/share/demo/test_atom.dyn +79 -0
  11. data/share/etc/alias +3 -0
  12. data/share/etc/dyndoc_library_path +1 -0
  13. data/share/etc/helpers +1 -0
  14. data/share/etc/pandoc/README.INSTALL +1 -0
  15. data/share/etc/pandoc/config.rb +4 -0
  16. data/share/etc/pandoc/extra/reveal.js-3.0.0/CONTRIBUTING.md +19 -0
  17. data/share/etc/pandoc/extra/reveal.js-3.0.0/Gruntfile.js +174 -0
  18. data/share/etc/pandoc/extra/reveal.js-3.0.0/LICENSE +19 -0
  19. data/share/etc/pandoc/extra/reveal.js-3.0.0/README.md +950 -0
  20. data/share/etc/pandoc/extra/reveal.js-3.0.0/css/print/paper.css +202 -0
  21. data/share/etc/pandoc/extra/reveal.js-3.0.0/css/print/pdf.css +157 -0
  22. data/share/etc/pandoc/extra/reveal.js-3.0.0/css/reveal.css +1141 -0
  23. data/share/etc/pandoc/extra/reveal.js-3.0.0/css/reveal.min.css +1141 -0
  24. data/share/etc/pandoc/extra/reveal.js-3.0.0/css/reveal.scss +1316 -0
  25. data/share/etc/pandoc/extra/reveal.js-3.0.0/css/theme/README.md +25 -0
  26. data/share/etc/pandoc/extra/reveal.js-3.0.0/css/theme/beige.css +265 -0
  27. data/share/etc/pandoc/extra/reveal.js-3.0.0/css/theme/black.css +261 -0
  28. data/share/etc/pandoc/extra/reveal.js-3.0.0/css/theme/blood.css +291 -0
  29. data/share/etc/pandoc/extra/reveal.js-3.0.0/css/theme/default.css +268 -0
  30. data/share/etc/pandoc/extra/reveal.js-3.0.0/css/theme/league.css +267 -0
  31. data/share/etc/pandoc/extra/reveal.js-3.0.0/css/theme/moon.css +265 -0
  32. data/share/etc/pandoc/extra/reveal.js-3.0.0/css/theme/night.css +259 -0
  33. data/share/etc/pandoc/extra/reveal.js-3.0.0/css/theme/serif.css +261 -0
  34. data/share/etc/pandoc/extra/reveal.js-3.0.0/css/theme/simple.css +261 -0
  35. data/share/etc/pandoc/extra/reveal.js-3.0.0/css/theme/sky.css +268 -0
  36. data/share/etc/pandoc/extra/reveal.js-3.0.0/css/theme/solarized.css +265 -0
  37. data/share/etc/pandoc/extra/reveal.js-3.0.0/css/theme/source/beige.scss +39 -0
  38. data/share/etc/pandoc/extra/reveal.js-3.0.0/css/theme/source/black.scss +49 -0
  39. data/share/etc/pandoc/extra/reveal.js-3.0.0/css/theme/source/blood.scss +91 -0
  40. data/share/etc/pandoc/extra/reveal.js-3.0.0/css/theme/source/league.scss +34 -0
  41. data/share/etc/pandoc/extra/reveal.js-3.0.0/css/theme/source/moon.scss +57 -0
  42. data/share/etc/pandoc/extra/reveal.js-3.0.0/css/theme/source/night.scss +35 -0
  43. data/share/etc/pandoc/extra/reveal.js-3.0.0/css/theme/source/serif.scss +35 -0
  44. data/share/etc/pandoc/extra/reveal.js-3.0.0/css/theme/source/simple.scss +38 -0
  45. data/share/etc/pandoc/extra/reveal.js-3.0.0/css/theme/source/sky.scss +46 -0
  46. data/share/etc/pandoc/extra/reveal.js-3.0.0/css/theme/source/solarized.scss +63 -0
  47. data/share/etc/pandoc/extra/reveal.js-3.0.0/css/theme/source/white.scss +49 -0
  48. data/share/etc/pandoc/extra/reveal.js-3.0.0/css/theme/template/mixins.scss +29 -0
  49. data/share/etc/pandoc/extra/reveal.js-3.0.0/css/theme/template/settings.scss +43 -0
  50. data/share/etc/pandoc/extra/reveal.js-3.0.0/css/theme/template/theme.scss +339 -0
  51. data/share/etc/pandoc/extra/reveal.js-3.0.0/css/theme/white.css +261 -0
  52. data/share/etc/pandoc/extra/reveal.js-3.0.0/index.html +408 -0
  53. data/share/etc/pandoc/extra/reveal.js-3.0.0/js/reveal.js +4276 -0
  54. data/share/etc/pandoc/extra/reveal.js-3.0.0/js/reveal.min.js +4276 -0
  55. data/share/etc/pandoc/extra/reveal.js-3.0.0/lib/css/zenburn.css +117 -0
  56. data/share/etc/pandoc/extra/reveal.js-3.0.0/lib/font/league-gothic/LICENSE +2 -0
  57. data/share/etc/pandoc/extra/reveal.js-3.0.0/lib/font/league-gothic/league-gothic.css +10 -0
  58. data/share/etc/pandoc/extra/reveal.js-3.0.0/lib/font/league-gothic/league-gothic.eot +0 -0
  59. data/share/etc/pandoc/extra/reveal.js-3.0.0/lib/font/league-gothic/league-gothic.ttf +0 -0
  60. data/share/etc/pandoc/extra/reveal.js-3.0.0/lib/font/league-gothic/league-gothic.woff +0 -0
  61. data/share/etc/pandoc/extra/reveal.js-3.0.0/lib/font/source-sans-pro/LICENSE +45 -0
  62. data/share/etc/pandoc/extra/reveal.js-3.0.0/lib/font/source-sans-pro/source-sans-pro-italic.eot +0 -0
  63. data/share/etc/pandoc/extra/reveal.js-3.0.0/lib/font/source-sans-pro/source-sans-pro-italic.ttf +0 -0
  64. data/share/etc/pandoc/extra/reveal.js-3.0.0/lib/font/source-sans-pro/source-sans-pro-italic.woff +0 -0
  65. data/share/etc/pandoc/extra/reveal.js-3.0.0/lib/font/source-sans-pro/source-sans-pro-regular.eot +0 -0
  66. data/share/etc/pandoc/extra/reveal.js-3.0.0/lib/font/source-sans-pro/source-sans-pro-regular.ttf +0 -0
  67. data/share/etc/pandoc/extra/reveal.js-3.0.0/lib/font/source-sans-pro/source-sans-pro-regular.woff +0 -0
  68. data/share/etc/pandoc/extra/reveal.js-3.0.0/lib/font/source-sans-pro/source-sans-pro-semibold.eot +0 -0
  69. data/share/etc/pandoc/extra/reveal.js-3.0.0/lib/font/source-sans-pro/source-sans-pro-semibold.ttf +0 -0
  70. data/share/etc/pandoc/extra/reveal.js-3.0.0/lib/font/source-sans-pro/source-sans-pro-semibold.woff +0 -0
  71. data/share/etc/pandoc/extra/reveal.js-3.0.0/lib/font/source-sans-pro/source-sans-pro-semibolditalic.eot +0 -0
  72. data/share/etc/pandoc/extra/reveal.js-3.0.0/lib/font/source-sans-pro/source-sans-pro-semibolditalic.ttf +0 -0
  73. data/share/etc/pandoc/extra/reveal.js-3.0.0/lib/font/source-sans-pro/source-sans-pro-semibolditalic.woff +0 -0
  74. data/share/etc/pandoc/extra/reveal.js-3.0.0/lib/font/source-sans-pro/source-sans-pro.css +39 -0
  75. data/share/etc/pandoc/extra/reveal.js-3.0.0/lib/js/classList.js +2 -0
  76. data/share/etc/pandoc/extra/reveal.js-3.0.0/lib/js/head.min.js +8 -0
  77. data/share/etc/pandoc/extra/reveal.js-3.0.0/lib/js/html5shiv.js +7 -0
  78. data/share/etc/pandoc/extra/reveal.js-3.0.0/package.json +48 -0
  79. data/share/etc/pandoc/extra/reveal.js-3.0.0/plugin/highlight/highlight.js +30 -0
  80. data/share/etc/pandoc/extra/reveal.js-3.0.0/plugin/leap/leap.js +159 -0
  81. data/share/etc/pandoc/extra/reveal.js-3.0.0/plugin/markdown/example.html +129 -0
  82. data/share/etc/pandoc/extra/reveal.js-3.0.0/plugin/markdown/example.md +31 -0
  83. data/share/etc/pandoc/extra/reveal.js-3.0.0/plugin/markdown/markdown.js +393 -0
  84. data/share/etc/pandoc/extra/reveal.js-3.0.0/plugin/markdown/marked.js +37 -0
  85. data/share/etc/pandoc/extra/reveal.js-3.0.0/plugin/math/math.js +64 -0
  86. data/share/etc/pandoc/extra/reveal.js-3.0.0/plugin/multiplex/client.js +13 -0
  87. data/share/etc/pandoc/extra/reveal.js-3.0.0/plugin/multiplex/index.js +56 -0
  88. data/share/etc/pandoc/extra/reveal.js-3.0.0/plugin/multiplex/master.js +51 -0
  89. data/share/etc/pandoc/extra/reveal.js-3.0.0/plugin/notes-server/client.js +60 -0
  90. data/share/etc/pandoc/extra/reveal.js-3.0.0/plugin/notes-server/index.js +66 -0
  91. data/share/etc/pandoc/extra/reveal.js-3.0.0/plugin/notes-server/notes.html +396 -0
  92. data/share/etc/pandoc/extra/reveal.js-3.0.0/plugin/notes/notes.html +406 -0
  93. data/share/etc/pandoc/extra/reveal.js-3.0.0/plugin/notes/notes.js +122 -0
  94. data/share/etc/pandoc/extra/reveal.js-3.0.0/plugin/print-pdf/print-pdf.js +48 -0
  95. data/share/etc/pandoc/extra/reveal.js-3.0.0/plugin/remotes/remotes.js +39 -0
  96. data/share/etc/pandoc/extra/reveal.js-3.0.0/plugin/search/search.js +196 -0
  97. data/share/etc/pandoc/extra/reveal.js-3.0.0/plugin/zoom-js/zoom.js +278 -0
  98. data/share/etc/pandoc/extra/reveal.js-3.0.0/test/examples/assets/image1.png +0 -0
  99. data/share/etc/pandoc/extra/reveal.js-3.0.0/test/examples/assets/image2.png +0 -0
  100. data/share/etc/pandoc/extra/reveal.js-3.0.0/test/examples/barebones.html +41 -0
  101. data/share/etc/pandoc/extra/reveal.js-3.0.0/test/examples/embedded-media.html +49 -0
  102. data/share/etc/pandoc/extra/reveal.js-3.0.0/test/examples/math.html +185 -0
  103. data/share/etc/pandoc/extra/reveal.js-3.0.0/test/examples/slide-backgrounds.html +144 -0
  104. data/share/etc/pandoc/extra/reveal.js-3.0.0/test/qunit-1.12.0.css +244 -0
  105. data/share/etc/pandoc/extra/reveal.js-3.0.0/test/qunit-1.12.0.js +2212 -0
  106. data/share/etc/pandoc/extra/reveal.js-3.0.0/test/test-markdown-element-attributes.html +134 -0
  107. data/share/etc/pandoc/extra/reveal.js-3.0.0/test/test-markdown-element-attributes.js +46 -0
  108. data/share/etc/pandoc/extra/reveal.js-3.0.0/test/test-markdown-slide-attributes.html +128 -0
  109. data/share/etc/pandoc/extra/reveal.js-3.0.0/test/test-markdown-slide-attributes.js +47 -0
  110. data/share/etc/pandoc/extra/reveal.js-3.0.0/test/test-markdown.html +52 -0
  111. data/share/etc/pandoc/extra/reveal.js-3.0.0/test/test-markdown.js +15 -0
  112. data/share/etc/pandoc/extra/reveal.js-3.0.0/test/test-pdf.html +83 -0
  113. data/share/etc/pandoc/extra/reveal.js-3.0.0/test/test-pdf.js +15 -0
  114. data/share/etc/pandoc/extra/reveal.js-3.0.0/test/test.html +82 -0
  115. data/share/etc/pandoc/extra/reveal.js-3.0.0/test/test.js +572 -0
  116. data/share/etc/pandoc/extra/reveal.js-3.1.0/CONTRIBUTING.md +23 -0
  117. data/share/etc/pandoc/extra/reveal.js-3.1.0/Gruntfile.js +170 -0
  118. data/share/etc/pandoc/extra/reveal.js-3.1.0/LICENSE +19 -0
  119. data/share/etc/pandoc/extra/reveal.js-3.1.0/README.md +1050 -0
  120. data/share/etc/pandoc/extra/reveal.js-3.1.0/css/print/paper.css +202 -0
  121. data/share/etc/pandoc/extra/reveal.js-3.1.0/css/print/pdf.css +157 -0
  122. data/share/etc/pandoc/extra/reveal.js-3.1.0/css/reveal.css +1175 -0
  123. data/share/etc/pandoc/extra/reveal.js-3.1.0/css/reveal.scss +1319 -0
  124. data/share/etc/pandoc/extra/reveal.js-3.1.0/css/theme/README.md +23 -0
  125. data/share/etc/pandoc/extra/reveal.js-3.1.0/css/theme/beige.css +271 -0
  126. data/share/etc/pandoc/extra/reveal.js-3.1.0/css/theme/black.css +267 -0
  127. data/share/etc/pandoc/extra/reveal.js-3.1.0/css/theme/blood.css +285 -0
  128. data/share/etc/pandoc/extra/reveal.js-3.1.0/css/theme/league.css +273 -0
  129. data/share/etc/pandoc/extra/reveal.js-3.1.0/css/theme/moon.css +271 -0
  130. data/share/etc/pandoc/extra/reveal.js-3.1.0/css/theme/night.css +265 -0
  131. data/share/etc/pandoc/extra/reveal.js-3.1.0/css/theme/serif.css +267 -0
  132. data/share/etc/pandoc/extra/reveal.js-3.1.0/css/theme/simple.css +267 -0
  133. data/share/etc/pandoc/extra/reveal.js-3.1.0/css/theme/sky.css +274 -0
  134. data/share/etc/pandoc/extra/reveal.js-3.1.0/css/theme/solarized.css +271 -0
  135. data/share/etc/pandoc/extra/reveal.js-3.1.0/css/theme/source/beige.scss +39 -0
  136. data/share/etc/pandoc/extra/reveal.js-3.1.0/css/theme/source/black.scss +49 -0
  137. data/share/etc/pandoc/extra/reveal.js-3.1.0/css/theme/source/blood.scss +79 -0
  138. data/share/etc/pandoc/extra/reveal.js-3.1.0/css/theme/source/league.scss +34 -0
  139. data/share/etc/pandoc/extra/reveal.js-3.1.0/css/theme/source/moon.scss +57 -0
  140. data/share/etc/pandoc/extra/reveal.js-3.1.0/css/theme/source/night.scss +35 -0
  141. data/share/etc/pandoc/extra/reveal.js-3.1.0/css/theme/source/serif.scss +35 -0
  142. data/share/etc/pandoc/extra/reveal.js-3.1.0/css/theme/source/simple.scss +38 -0
  143. data/share/etc/pandoc/extra/reveal.js-3.1.0/css/theme/source/sky.scss +46 -0
  144. data/share/etc/pandoc/extra/reveal.js-3.1.0/css/theme/source/solarized.scss +63 -0
  145. data/share/etc/pandoc/extra/reveal.js-3.1.0/css/theme/source/white.scss +49 -0
  146. data/share/etc/pandoc/extra/reveal.js-3.1.0/css/theme/template/mixins.scss +29 -0
  147. data/share/etc/pandoc/extra/reveal.js-3.1.0/css/theme/template/settings.scss +43 -0
  148. data/share/etc/pandoc/extra/reveal.js-3.1.0/css/theme/template/theme.scss +349 -0
  149. data/share/etc/pandoc/extra/reveal.js-3.1.0/css/theme/white.css +267 -0
  150. data/share/etc/pandoc/extra/reveal.js-3.1.0/index.html +411 -0
  151. data/share/etc/pandoc/extra/reveal.js-3.1.0/js/reveal.js +4508 -0
  152. data/share/etc/pandoc/extra/reveal.js-3.1.0/lib/css/zenburn.css +117 -0
  153. data/share/etc/pandoc/extra/reveal.js-3.1.0/lib/font/league-gothic/LICENSE +2 -0
  154. data/share/etc/pandoc/extra/reveal.js-3.1.0/lib/font/league-gothic/league-gothic.css +10 -0
  155. data/share/etc/pandoc/extra/reveal.js-3.1.0/lib/font/league-gothic/league-gothic.eot +0 -0
  156. data/share/etc/pandoc/extra/reveal.js-3.1.0/lib/font/league-gothic/league-gothic.ttf +0 -0
  157. data/share/etc/pandoc/extra/reveal.js-3.1.0/lib/font/league-gothic/league-gothic.woff +0 -0
  158. data/share/etc/pandoc/extra/reveal.js-3.1.0/lib/font/source-sans-pro/LICENSE +45 -0
  159. data/share/etc/pandoc/extra/reveal.js-3.1.0/lib/font/source-sans-pro/source-sans-pro-italic.eot +0 -0
  160. data/share/etc/pandoc/extra/reveal.js-3.1.0/lib/font/source-sans-pro/source-sans-pro-italic.ttf +0 -0
  161. data/share/etc/pandoc/extra/reveal.js-3.1.0/lib/font/source-sans-pro/source-sans-pro-italic.woff +0 -0
  162. data/share/etc/pandoc/extra/reveal.js-3.1.0/lib/font/source-sans-pro/source-sans-pro-regular.eot +0 -0
  163. data/share/etc/pandoc/extra/reveal.js-3.1.0/lib/font/source-sans-pro/source-sans-pro-regular.ttf +0 -0
  164. data/share/etc/pandoc/extra/reveal.js-3.1.0/lib/font/source-sans-pro/source-sans-pro-regular.woff +0 -0
  165. data/share/etc/pandoc/extra/reveal.js-3.1.0/lib/font/source-sans-pro/source-sans-pro-semibold.eot +0 -0
  166. data/share/etc/pandoc/extra/reveal.js-3.1.0/lib/font/source-sans-pro/source-sans-pro-semibold.ttf +0 -0
  167. data/share/etc/pandoc/extra/reveal.js-3.1.0/lib/font/source-sans-pro/source-sans-pro-semibold.woff +0 -0
  168. data/share/etc/pandoc/extra/reveal.js-3.1.0/lib/font/source-sans-pro/source-sans-pro-semibolditalic.eot +0 -0
  169. data/share/etc/pandoc/extra/reveal.js-3.1.0/lib/font/source-sans-pro/source-sans-pro-semibolditalic.ttf +0 -0
  170. data/share/etc/pandoc/extra/reveal.js-3.1.0/lib/font/source-sans-pro/source-sans-pro-semibolditalic.woff +0 -0
  171. data/share/etc/pandoc/extra/reveal.js-3.1.0/lib/font/source-sans-pro/source-sans-pro.css +39 -0
  172. data/share/etc/pandoc/extra/reveal.js-3.1.0/lib/js/classList.js +2 -0
  173. data/share/etc/pandoc/extra/reveal.js-3.1.0/lib/js/head.min.js +8 -0
  174. data/share/etc/pandoc/extra/reveal.js-3.1.0/lib/js/html5shiv.js +7 -0
  175. data/share/etc/pandoc/extra/reveal.js-3.1.0/package.json +49 -0
  176. data/share/etc/pandoc/extra/reveal.js-3.1.0/plugin/highlight/highlight.js +30 -0
  177. data/share/etc/pandoc/extra/reveal.js-3.1.0/plugin/leap/leap.js +159 -0
  178. data/share/etc/pandoc/extra/reveal.js-3.1.0/plugin/markdown/example.html +129 -0
  179. data/share/etc/pandoc/extra/reveal.js-3.1.0/plugin/markdown/example.md +31 -0
  180. data/share/etc/pandoc/extra/reveal.js-3.1.0/plugin/markdown/markdown.js +393 -0
  181. data/share/etc/pandoc/extra/reveal.js-3.1.0/plugin/markdown/marked.js +6 -0
  182. data/share/etc/pandoc/extra/reveal.js-3.1.0/plugin/math/math.js +64 -0
  183. data/share/etc/pandoc/extra/reveal.js-3.1.0/plugin/multiplex/client.js +13 -0
  184. data/share/etc/pandoc/extra/reveal.js-3.1.0/plugin/multiplex/index.js +56 -0
  185. data/share/etc/pandoc/extra/reveal.js-3.1.0/plugin/multiplex/master.js +51 -0
  186. data/share/etc/pandoc/extra/reveal.js-3.1.0/plugin/notes-server/client.js +60 -0
  187. data/share/etc/pandoc/extra/reveal.js-3.1.0/plugin/notes-server/index.js +66 -0
  188. data/share/etc/pandoc/extra/reveal.js-3.1.0/plugin/notes-server/notes.html +396 -0
  189. data/share/etc/pandoc/extra/reveal.js-3.1.0/plugin/notes/notes.html +406 -0
  190. data/share/etc/pandoc/extra/reveal.js-3.1.0/plugin/notes/notes.js +122 -0
  191. data/share/etc/pandoc/extra/reveal.js-3.1.0/plugin/print-pdf/print-pdf.js +48 -0
  192. data/share/etc/pandoc/extra/reveal.js-3.1.0/plugin/remotes/remotes.js +39 -0
  193. data/share/etc/pandoc/extra/reveal.js-3.1.0/plugin/search/search.js +196 -0
  194. data/share/etc/pandoc/extra/reveal.js-3.1.0/plugin/zoom-js/zoom.js +278 -0
  195. data/share/etc/pandoc/extra/reveal.js-3.1.0/test/examples/assets/image1.png +0 -0
  196. data/share/etc/pandoc/extra/reveal.js-3.1.0/test/examples/assets/image2.png +0 -0
  197. data/share/etc/pandoc/extra/reveal.js-3.1.0/test/examples/barebones.html +41 -0
  198. data/share/etc/pandoc/extra/reveal.js-3.1.0/test/examples/embedded-media.html +49 -0
  199. data/share/etc/pandoc/extra/reveal.js-3.1.0/test/examples/math.html +185 -0
  200. data/share/etc/pandoc/extra/reveal.js-3.1.0/test/examples/slide-backgrounds.html +144 -0
  201. data/share/etc/pandoc/extra/reveal.js-3.1.0/test/examples/slide-transitions.html +101 -0
  202. data/share/etc/pandoc/extra/reveal.js-3.1.0/test/qunit-1.12.0.css +244 -0
  203. data/share/etc/pandoc/extra/reveal.js-3.1.0/test/qunit-1.12.0.js +2212 -0
  204. data/share/etc/pandoc/extra/reveal.js-3.1.0/test/test-markdown-element-attributes.html +134 -0
  205. data/share/etc/pandoc/extra/reveal.js-3.1.0/test/test-markdown-element-attributes.js +46 -0
  206. data/share/etc/pandoc/extra/reveal.js-3.1.0/test/test-markdown-slide-attributes.html +128 -0
  207. data/share/etc/pandoc/extra/reveal.js-3.1.0/test/test-markdown-slide-attributes.js +47 -0
  208. data/share/etc/pandoc/extra/reveal.js-3.1.0/test/test-markdown.html +52 -0
  209. data/share/etc/pandoc/extra/reveal.js-3.1.0/test/test-markdown.js +15 -0
  210. data/share/etc/pandoc/extra/reveal.js-3.1.0/test/test-pdf.html +83 -0
  211. data/share/etc/pandoc/extra/reveal.js-3.1.0/test/test-pdf.js +15 -0
  212. data/share/etc/pandoc/extra/reveal.js-3.1.0/test/test.html +85 -0
  213. data/share/etc/pandoc/extra/reveal.js-3.1.0/test/test.js +589 -0
  214. data/share/etc/pandoc/extra/s5-ui/default/blank.gif +0 -0
  215. data/share/etc/pandoc/extra/s5-ui/default/bodybg.gif +0 -0
  216. data/share/etc/pandoc/extra/s5-ui/default/framing.css +23 -0
  217. data/share/etc/pandoc/extra/s5-ui/default/iepngfix.htc +42 -0
  218. data/share/etc/pandoc/extra/s5-ui/default/opera.css +7 -0
  219. data/share/etc/pandoc/extra/s5-ui/default/outline.css +15 -0
  220. data/share/etc/pandoc/extra/s5-ui/default/pretty.css +86 -0
  221. data/share/etc/pandoc/extra/s5-ui/default/print.css +1 -0
  222. data/share/etc/pandoc/extra/s5-ui/default/s5-core.css +9 -0
  223. data/share/etc/pandoc/extra/s5-ui/default/slides.css +3 -0
  224. data/share/etc/pandoc/extra/s5-ui/default/slides.js +553 -0
  225. data/share/etc/uv/render/README +1 -0
  226. data/share/etc/uv/render/latex/-h.yaml +1 -0
  227. data/share/etc/uv/render/latex/active4d.render +136 -0
  228. data/share/etc/uv/render/latex/all_hallows_eve.render +100 -0
  229. data/share/etc/uv/render/latex/amy.render +175 -0
  230. data/share/etc/uv/render/latex/blackboard.render +115 -0
  231. data/share/etc/uv/render/latex/brilliance_black.render +556 -0
  232. data/share/etc/uv/render/latex/brilliance_dull.render +565 -0
  233. data/share/etc/uv/render/latex/cobalt.render +166 -0
  234. data/share/etc/uv/render/latex/dawn.render +130 -0
  235. data/share/etc/uv/render/latex/eiffel.render +136 -0
  236. data/share/etc/uv/render/latex/espresso_libre.render +127 -0
  237. data/share/etc/uv/render/latex/idle.render +97 -0
  238. data/share/etc/uv/render/latex/iplastic.render +103 -0
  239. data/share/etc/uv/render/latex/lazy.render +100 -0
  240. data/share/etc/uv/render/latex/mac_classic.render +139 -0
  241. data/share/etc/uv/render/latex/magicwb_amiga.render +121 -0
  242. data/share/etc/uv/render/latex/pastels_on_dark.render +208 -0
  243. data/share/etc/uv/render/latex/slush_poppies.render +127 -0
  244. data/share/etc/uv/render/latex/solarized.render +495 -0
  245. data/share/etc/uv/render/latex/spacecadet.render +85 -0
  246. data/share/etc/uv/render/latex/sunburst.render +190 -0
  247. data/share/etc/uv/render/latex/twilight.render +157 -0
  248. data/share/etc/uv/render/latex/zenburnesque.render +130 -0
  249. data/share/etc/uv/render/old/txt2tags.render +131 -0
  250. data/share/etc/uv/render/theme2latexrender +123 -0
  251. data/share/etc/uv/render/theme2xhtmlrender +157 -0
  252. data/share/etc/uv/render/tmTheme/solarized.tmTheme +1875 -0
  253. data/share/etc/uv/render/xhtml/active4d.render +140 -0
  254. data/share/etc/uv/render/xhtml/all_hallows_eve.render +104 -0
  255. data/share/etc/uv/render/xhtml/amy.render +179 -0
  256. data/share/etc/uv/render/xhtml/blackboard.render +119 -0
  257. data/share/etc/uv/render/xhtml/brilliance_black.render +560 -0
  258. data/share/etc/uv/render/xhtml/brilliance_dull.render +569 -0
  259. data/share/etc/uv/render/xhtml/cobalt.render +170 -0
  260. data/share/etc/uv/render/xhtml/dawn.render +134 -0
  261. data/share/etc/uv/render/xhtml/eiffel.render +140 -0
  262. data/share/etc/uv/render/xhtml/espresso_libre.render +131 -0
  263. data/share/etc/uv/render/xhtml/files/css/active4d.css +114 -0
  264. data/share/etc/uv/render/xhtml/files/css/all_hallows_eve.css +72 -0
  265. data/share/etc/uv/render/xhtml/files/css/amy.css +147 -0
  266. data/share/etc/uv/render/xhtml/files/css/blackboard.css +88 -0
  267. data/share/etc/uv/render/xhtml/files/css/brilliance_black.css +605 -0
  268. data/share/etc/uv/render/xhtml/files/css/brilliance_dull.css +599 -0
  269. data/share/etc/uv/render/xhtml/files/css/cobalt.css +149 -0
  270. data/share/etc/uv/render/xhtml/files/css/dawn.css +121 -0
  271. data/share/etc/uv/render/xhtml/files/css/eiffel.css +121 -0
  272. data/share/etc/uv/render/xhtml/files/css/espresso_libre.css +109 -0
  273. data/share/etc/uv/render/xhtml/files/css/idle.css +62 -0
  274. data/share/etc/uv/render/xhtml/files/css/iplastic.css +80 -0
  275. data/share/etc/uv/render/xhtml/files/css/lazy.css +73 -0
  276. data/share/etc/uv/render/xhtml/files/css/mac_classic.css +123 -0
  277. data/share/etc/uv/render/xhtml/files/css/magicwb_amiga.css +104 -0
  278. data/share/etc/uv/render/xhtml/files/css/pastels_on_dark.css +188 -0
  279. data/share/etc/uv/render/xhtml/files/css/slush_poppies.css +85 -0
  280. data/share/etc/uv/render/xhtml/files/css/solarized.css +478 -0
  281. data/share/etc/uv/render/xhtml/files/css/spacecadet.css +51 -0
  282. data/share/etc/uv/render/xhtml/files/css/sunburst.css +180 -0
  283. data/share/etc/uv/render/xhtml/files/css/twilight.css +137 -0
  284. data/share/etc/uv/render/xhtml/files/css/zenburnesque.css +91 -0
  285. data/share/etc/uv/render/xhtml/idle.render +101 -0
  286. data/share/etc/uv/render/xhtml/iplastic.render +107 -0
  287. data/share/etc/uv/render/xhtml/lazy.render +104 -0
  288. data/share/etc/uv/render/xhtml/mac_classic.render +143 -0
  289. data/share/etc/uv/render/xhtml/magicwb_amiga.render +125 -0
  290. data/share/etc/uv/render/xhtml/pastels_on_dark.render +212 -0
  291. data/share/etc/uv/render/xhtml/slush_poppies.render +131 -0
  292. data/share/etc/uv/render/xhtml/solarized.render +503 -0
  293. data/share/etc/uv/render/xhtml/spacecadet.render +89 -0
  294. data/share/etc/uv/render/xhtml/sunburst.render +194 -0
  295. data/share/etc/uv/render/xhtml/twilight.render +161 -0
  296. data/share/etc/uv/render/xhtml/zenburnesque.render +134 -0
  297. data/share/etc/uv/syntax/broken/markdown.syntax +519 -0
  298. data/share/etc/uv/syntax/broken/php.syntax +1253 -0
  299. data/share/etc/uv/syntax/buggy/nemerle.syntax +74 -0
  300. data/share/etc/uv/syntax/dyndoc.syntax +237 -0
  301. data/share/etc/uv/syntax/old/YAML.yaml +160 -0
  302. data/share/etc/uv/syntax/old/txt2tags.yaml +139 -0
  303. data/share/etc/uv/syntax/r.syntax +81 -0
  304. data/share/etc/uv/syntax/ruby.syntax +1035 -0
  305. data/share/etc/uv/syntax/source.actionscript.syntax +97 -0
  306. data/share/etc/uv/syntax/source.active4d.library.syntax +21 -0
  307. data/share/etc/uv/syntax/source.active4d.syntax +276 -0
  308. data/share/etc/uv/syntax/source.ada.syntax +33 -0
  309. data/share/etc/uv/syntax/source.antlr.syntax +151 -0
  310. data/share/etc/uv/syntax/source.apache-config.mod_perl.syntax +50 -0
  311. data/share/etc/uv/syntax/source.apache-config.syntax +191 -0
  312. data/share/etc/uv/syntax/source.applescript.syntax +384 -0
  313. data/share/etc/uv/syntax/source.asp.syntax +70 -0
  314. data/share/etc/uv/syntax/source.asp.vb.net.syntax +129 -0
  315. data/share/etc/uv/syntax/source.c++.qt.syntax +26 -0
  316. data/share/etc/uv/syntax/source.c++.syntax +186 -0
  317. data/share/etc/uv/syntax/source.c-sharp.syntax +59 -0
  318. data/share/etc/uv/syntax/source.c.ragel.syntax +201 -0
  319. data/share/etc/uv/syntax/source.c.syntax +414 -0
  320. data/share/etc/uv/syntax/source.camlp4.ocaml.syntax +36 -0
  321. data/share/etc/uv/syntax/source.cm.syntax +32 -0
  322. data/share/etc/uv/syntax/source.coffee.syntax +216 -0
  323. data/share/etc/uv/syntax/source.context-free.syntax +176 -0
  324. data/share/etc/uv/syntax/source.css.beta.syntax +1925 -0
  325. data/share/etc/uv/syntax/source.css.syntax +195 -0
  326. data/share/etc/uv/syntax/source.d.syntax +142 -0
  327. data/share/etc/uv/syntax/source.diff.syntax +81 -0
  328. data/share/etc/uv/syntax/source.dot.syntax +47 -0
  329. data/share/etc/uv/syntax/source.dylan.syntax +62 -0
  330. data/share/etc/uv/syntax/source.eiffel.syntax +78 -0
  331. data/share/etc/uv/syntax/source.erlang.syntax +922 -0
  332. data/share/etc/uv/syntax/source.fortran.syntax +141 -0
  333. data/share/etc/uv/syntax/source.fscript.syntax +80 -0
  334. data/share/etc/uv/syntax/source.fxscript.syntax +142 -0
  335. data/share/etc/uv/syntax/source.gri.syntax +83 -0
  336. data/share/etc/uv/syntax/source.groovy.groovy.syntax +191 -0
  337. data/share/etc/uv/syntax/source.haskell.syntax +88 -0
  338. data/share/etc/uv/syntax/source.icalendar.syntax +32 -0
  339. data/share/etc/uv/syntax/source.inform.syntax +48 -0
  340. data/share/etc/uv/syntax/source.ini.syntax +55 -0
  341. data/share/etc/uv/syntax/source.io.syntax +81 -0
  342. data/share/etc/uv/syntax/source.java-props.syntax +20 -0
  343. data/share/etc/uv/syntax/source.java.syntax +211 -0
  344. data/share/etc/uv/syntax/source.js.greasemonkey.syntax +34 -0
  345. data/share/etc/uv/syntax/source.js.jquery.syntax +114 -0
  346. data/share/etc/uv/syntax/source.js.mootools.syntax +572 -0
  347. data/share/etc/uv/syntax/source.js.prototype.bracketed.syntax +140 -0
  348. data/share/etc/uv/syntax/source.js.prototype.syntax +72 -0
  349. data/share/etc/uv/syntax/source.js.syntax +256 -0
  350. data/share/etc/uv/syntax/source.js.yui.syntax +176 -0
  351. data/share/etc/uv/syntax/source.json.syntax +136 -0
  352. data/share/etc/uv/syntax/source.lex.syntax +219 -0
  353. data/share/etc/uv/syntax/source.lighttpd-config.syntax +54 -0
  354. data/share/etc/uv/syntax/source.lilypond.syntax +492 -0
  355. data/share/etc/uv/syntax/source.lisp.syntax +61 -0
  356. data/share/etc/uv/syntax/source.logo.syntax +29 -0
  357. data/share/etc/uv/syntax/source.logtalk.syntax +152 -0
  358. data/share/etc/uv/syntax/source.lua.syntax +86 -0
  359. data/share/etc/uv/syntax/source.makefile.syntax +36 -0
  360. data/share/etc/uv/syntax/source.matlab.syntax +142 -0
  361. data/share/etc/uv/syntax/source.mel.syntax +92 -0
  362. data/share/etc/uv/syntax/source.mips.syntax +66 -0
  363. data/share/etc/uv/syntax/source.ml.syntax +121 -0
  364. data/share/etc/uv/syntax/source.modula-3.syntax +47 -0
  365. data/share/etc/uv/syntax/source.nant-build.syntax +53 -0
  366. data/share/etc/uv/syntax/source.objc++.syntax +18 -0
  367. data/share/etc/uv/syntax/source.objc.syntax +233 -0
  368. data/share/etc/uv/syntax/source.ocaml.syntax +764 -0
  369. data/share/etc/uv/syntax/source.ocamllex.syntax +167 -0
  370. data/share/etc/uv/syntax/source.ocamlyacc.syntax +184 -0
  371. data/share/etc/uv/syntax/source.open-gl.syntax +14 -0
  372. data/share/etc/uv/syntax/source.pascal.syntax +77 -0
  373. data/share/etc/uv/syntax/source.pascal.vectorscript.syntax +57 -0
  374. data/share/etc/uv/syntax/source.perl.syntax +1113 -0
  375. data/share/etc/uv/syntax/source.php.cake.syntax +55 -0
  376. data/share/etc/uv/syntax/source.plist.tm-grammar.syntax +708 -0
  377. data/share/etc/uv/syntax/source.postscript.syntax +114 -0
  378. data/share/etc/uv/syntax/source.processing.syntax +106 -0
  379. data/share/etc/uv/syntax/source.prolog.syntax +40 -0
  380. data/share/etc/uv/syntax/source.python.django.syntax +21 -0
  381. data/share/etc/uv/syntax/source.python.syntax +868 -0
  382. data/share/etc/uv/syntax/source.qmake.syntax +114 -0
  383. data/share/etc/uv/syntax/source.quake-config.syntax +32 -0
  384. data/share/etc/uv/syntax/source.r-console.syntax +16 -0
  385. data/share/etc/uv/syntax/source.r.syntax +81 -0
  386. data/share/etc/uv/syntax/source.regexp.oniguruma.syntax +107 -0
  387. data/share/etc/uv/syntax/source.regexp.python.syntax +109 -0
  388. data/share/etc/uv/syntax/source.regexp.syntax +50 -0
  389. data/share/etc/uv/syntax/source.remind.syntax +253 -0
  390. data/share/etc/uv/syntax/source.rez.syntax +80 -0
  391. data/share/etc/uv/syntax/source.ruby.experimental.syntax +145 -0
  392. data/share/etc/uv/syntax/source.ruby.rails.syntax +88 -0
  393. data/share/etc/uv/syntax/source.ruby.syntax +1035 -0
  394. data/share/etc/uv/syntax/source.s5.syntax +69 -0
  395. data/share/etc/uv/syntax/source.sass.syntax +45 -0
  396. data/share/etc/uv/syntax/source.scheme.syntax +347 -0
  397. data/share/etc/uv/syntax/source.scilab.syntax +41 -0
  398. data/share/etc/uv/syntax/source.scss.syntax +527 -0
  399. data/share/etc/uv/syntax/source.shell.syntax +384 -0
  400. data/share/etc/uv/syntax/source.slate.syntax +149 -0
  401. data/share/etc/uv/syntax/source.smarty.syntax +63 -0
  402. data/share/etc/uv/syntax/source.sql.ruby.syntax +18 -0
  403. data/share/etc/uv/syntax/source.sql.syntax +237 -0
  404. data/share/etc/uv/syntax/source.ssh-config.syntax +33 -0
  405. data/share/etc/uv/syntax/source.strings.syntax +39 -0
  406. data/share/etc/uv/syntax/source.swig.syntax +57 -0
  407. data/share/etc/uv/syntax/source.tcl.macports.syntax +163 -0
  408. data/share/etc/uv/syntax/source.tcl.syntax +152 -0
  409. data/share/etc/uv/syntax/source.yaml.syntax +160 -0
  410. data/share/etc/uv/syntax/text.active4d-ini.syntax +50 -0
  411. data/share/etc/uv/syntax/text.bbcode.syntax +287 -0
  412. data/share/etc/uv/syntax/text.bibtex.syntax +151 -0
  413. data/share/etc/uv/syntax/text.blog.html.syntax +41 -0
  414. data/share/etc/uv/syntax/text.blog.markdown.syntax +42 -0
  415. data/share/etc/uv/syntax/text.blog.syntax +27 -0
  416. data/share/etc/uv/syntax/text.blog.textile.syntax +27 -0
  417. data/share/etc/uv/syntax/text.dyndoc.syntax +237 -0
  418. data/share/etc/uv/syntax/text.gtdalt.syntax +143 -0
  419. data/share/etc/uv/syntax/text.haml.syntax +88 -0
  420. data/share/etc/uv/syntax/text.html.asp.net.syntax +424 -0
  421. data/share/etc/uv/syntax/text.html.asp.syntax +27 -0
  422. data/share/etc/uv/syntax/text.html.basic.syntax +362 -0
  423. data/share/etc/uv/syntax/text.html.cfm.syntax +119 -0
  424. data/share/etc/uv/syntax/text.html.django.syntax +36 -0
  425. data/share/etc/uv/syntax/text.html.dokuwiki.syntax +204 -0
  426. data/share/etc/uv/syntax/text.html.doxygen.syntax +43 -0
  427. data/share/etc/uv/syntax/text.html.markdown.multimarkdown.syntax +39 -0
  428. data/share/etc/uv/syntax/text.html.mason.syntax +119 -0
  429. data/share/etc/uv/syntax/text.html.mediawiki.syntax +567 -0
  430. data/share/etc/uv/syntax/text.html.mt.syntax +162 -0
  431. data/share/etc/uv/syntax/text.html.ruby.syntax +40 -0
  432. data/share/etc/uv/syntax/text.html.strict.active4d.syntax +311 -0
  433. data/share/etc/uv/syntax/text.html.tcl.syntax +26 -0
  434. data/share/etc/uv/syntax/text.html.textile.syntax +215 -0
  435. data/share/etc/uv/syntax/text.html.tt.syntax +121 -0
  436. data/share/etc/uv/syntax/text.html.twiki.syntax +241 -0
  437. data/share/etc/uv/syntax/text.html.xhtml.1-strict.syntax +4027 -0
  438. data/share/etc/uv/syntax/text.log.latex.syntax +50 -0
  439. data/share/etc/uv/syntax/text.mail.markdown.syntax +118 -0
  440. data/share/etc/uv/syntax/text.man.syntax +17 -0
  441. data/share/etc/uv/syntax/text.moinmoin.syntax +189 -0
  442. data/share/etc/uv/syntax/text.plain.gtd.syntax +22 -0
  443. data/share/etc/uv/syntax/text.plain.release-notes.syntax +46 -0
  444. data/share/etc/uv/syntax/text.plain.syntax +32 -0
  445. data/share/etc/uv/syntax/text.plist.syntax +635 -0
  446. data/share/etc/uv/syntax/text.pmwiki.syntax +113 -0
  447. data/share/etc/uv/syntax/text.restructuredtext.syntax +250 -0
  448. data/share/etc/uv/syntax/text.setext.syntax +147 -0
  449. data/share/etc/uv/syntax/text.subversion-commit.syntax +36 -0
  450. data/share/etc/uv/syntax/text.tabular.csv.syntax +68 -0
  451. data/share/etc/uv/syntax/text.tabular.tsv.syntax +50 -0
  452. data/share/etc/uv/syntax/text.tex.latex.beamer.syntax +41 -0
  453. data/share/etc/uv/syntax/text.tex.latex.haskell.syntax +24 -0
  454. data/share/etc/uv/syntax/text.tex.latex.memoir.syntax +64 -0
  455. data/share/etc/uv/syntax/text.tex.latex.rd.syntax +91 -0
  456. data/share/etc/uv/syntax/text.tex.latex.sweave.syntax +84 -0
  457. data/share/etc/uv/syntax/text.tex.latex.syntax +566 -0
  458. data/share/etc/uv/syntax/text.tex.math.syntax +49 -0
  459. data/share/etc/uv/syntax/text.tex.syntax +86 -0
  460. data/share/etc/uv/syntax/text.txt2tags.syntax +79 -0
  461. data/share/etc/uv/syntax/text.xml.apple-dist.syntax +77 -0
  462. data/share/etc/uv/syntax/text.xml.strict.syntax +92 -0
  463. data/share/etc/uv/syntax/text.xml.syntax +180 -0
  464. data/share/etc/uv/syntax/text.xml.xsl.syntax +60 -0
  465. data/share/etc/uv/uv.rb +161 -0
  466. metadata +465 -1
@@ -0,0 +1,19 @@
1
+ Copyright (C) 2015 Hakim El Hattab, http://hakim.se
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining a copy
4
+ of this software and associated documentation files (the "Software"), to deal
5
+ in the Software without restriction, including without limitation the rights
6
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7
+ copies of the Software, and to permit persons to whom the Software is
8
+ furnished to do so, subject to the following conditions:
9
+
10
+ The above copyright notice and this permission notice shall be included in
11
+ all copies or substantial portions of the Software.
12
+
13
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19
+ THE SOFTWARE.
@@ -0,0 +1,950 @@
1
+ # reveal.js [![Build Status](https://travis-ci.org/hakimel/reveal.js.svg?branch=master)](https://travis-ci.org/hakimel/reveal.js)
2
+
3
+ A framework for easily creating beautiful presentations using HTML. [Check out the live demo](http://lab.hakim.se/reveal-js/).
4
+
5
+ reveal.js comes with a broad range of features including [nested slides](https://github.com/hakimel/reveal.js#markup), [Markdown contents](https://github.com/hakimel/reveal.js#markdown), [PDF export](https://github.com/hakimel/reveal.js#pdf-export), [speaker notes](https://github.com/hakimel/reveal.js#speaker-notes) and a [JavaScript API](https://github.com/hakimel/reveal.js#api). It's best viewed in a modern browser but [fallbacks](https://github.com/hakimel/reveal.js/wiki/Browser-Support) are available to make sure your presentation can still be viewed elsewhere.
6
+
7
+
8
+ #### More reading:
9
+ - [Installation](#installation): Step-by-step instructions for getting reveal.js running on your computer.
10
+ - [Changelog](https://github.com/hakimel/reveal.js/releases): Up-to-date version history.
11
+ - [Examples](https://github.com/hakimel/reveal.js/wiki/Example-Presentations): Presentations created with reveal.js, add your own!
12
+ - [Browser Support](https://github.com/hakimel/reveal.js/wiki/Browser-Support): Explanation of browser support and fallbacks.
13
+
14
+ ## Online Editor
15
+
16
+ Presentations are written using HTML or Markdown but there's also an online editor for those of you who prefer a graphical interface. Give it a try at [http://slides.com](http://slides.com).
17
+
18
+
19
+ ## Instructions
20
+
21
+ ### Markup
22
+
23
+ Markup hierarchy needs to be ``<div class="reveal"> <div class="slides"> <section>`` where the ``<section>`` represents one slide and can be repeated indefinitely. If you place multiple ``<section>``'s inside of another ``<section>`` they will be shown as vertical slides. The first of the vertical slides is the "root" of the others (at the top), and it will be included in the horizontal sequence. For example:
24
+
25
+ ```html
26
+ <div class="reveal">
27
+ <div class="slides">
28
+ <section>Single Horizontal Slide</section>
29
+ <section>
30
+ <section>Vertical Slide 1</section>
31
+ <section>Vertical Slide 2</section>
32
+ </section>
33
+ </div>
34
+ </div>
35
+ ```
36
+
37
+ ### Markdown
38
+
39
+ 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 ```<script type="text/template">``` like the example below.
40
+
41
+ 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 Flavoured Markdown](https://help.github.com/articles/github-flavored-markdown). Sensitive to indentation (avoid mixing tabs and spaces) and line breaks (avoid consecutive breaks).
42
+
43
+ ```html
44
+ <section data-markdown>
45
+ <script type="text/template">
46
+ ## Page title
47
+
48
+ A paragraph with some text and a [link](http://hakim.se).
49
+ </script>
50
+ </section>
51
+ ```
52
+
53
+ #### External Markdown
54
+
55
+ You can write your content as a separate file and have reveal.js load it at runtime. Note the separator arguments which determine how slides are delimited in the external file. The ```data-charset``` attribute is optional and specifies which charset to use when loading the external file.
56
+
57
+ When used locally, this feature requires that reveal.js [runs from a local web server](#full-setup).
58
+
59
+ ```html
60
+ <section data-markdown="example.md"
61
+ data-separator="^\n\n\n"
62
+ data-separator-vertical="^\n\n"
63
+ data-separator-notes="^Note:"
64
+ data-charset="iso-8859-15">
65
+ </section>
66
+ ```
67
+
68
+ #### Element Attributes
69
+
70
+ Special syntax (in html comment) is available for adding attributes to Markdown elements. This is useful for fragments, amongst other things.
71
+
72
+ ```html
73
+ <section data-markdown>
74
+ <script type="text/template">
75
+ - Item 1 <!-- .element: class="fragment" data-fragment-index="2" -->
76
+ - Item 2 <!-- .element: class="fragment" data-fragment-index="1" -->
77
+ </script>
78
+ </section>
79
+ ```
80
+
81
+ #### Slide Attributes
82
+
83
+ Special syntax (in html comment) is available for adding attributes to the slide `<section>` elements generated by your Markdown.
84
+
85
+ ```html
86
+ <section data-markdown>
87
+ <script type="text/template">
88
+ <!-- .slide: data-background="#ff0000" -->
89
+ Markdown content
90
+ </script>
91
+ </section>
92
+ ```
93
+
94
+
95
+ ### Configuration
96
+
97
+ At the end of your page you need to initialize reveal by running the following code. Note that all config values are optional and will default as specified below.
98
+
99
+ ```javascript
100
+ Reveal.initialize({
101
+
102
+ // Display controls in the bottom right corner
103
+ controls: true,
104
+
105
+ // Display a presentation progress bar
106
+ progress: true,
107
+
108
+ // Display the page number of the current slide
109
+ slideNumber: false,
110
+
111
+ // Push each slide change to the browser history
112
+ history: false,
113
+
114
+ // Enable keyboard shortcuts for navigation
115
+ keyboard: true,
116
+
117
+ // Enable the slide overview mode
118
+ overview: true,
119
+
120
+ // Vertical centering of slides
121
+ center: true,
122
+
123
+ // Enables touch navigation on devices with touch input
124
+ touch: true,
125
+
126
+ // Loop the presentation
127
+ loop: false,
128
+
129
+ // Change the presentation direction to be RTL
130
+ rtl: false,
131
+
132
+ // Turns fragments on and off globally
133
+ fragments: true,
134
+
135
+ // Flags if the presentation is running in an embedded mode,
136
+ // i.e. contained within a limited portion of the screen
137
+ embedded: false,
138
+
139
+ // Flags if we should show a help overlay when the questionmark
140
+ // key is pressed
141
+ help: true,
142
+
143
+ // Number of milliseconds between automatically proceeding to the
144
+ // next slide, disabled when set to 0, this value can be overwritten
145
+ // by using a data-autoslide attribute on your slides
146
+ autoSlide: 0,
147
+
148
+ // Stop auto-sliding after user input
149
+ autoSlideStoppable: true,
150
+
151
+ // Enable slide navigation via mouse wheel
152
+ mouseWheel: false,
153
+
154
+ // Hides the address bar on mobile devices
155
+ hideAddressBar: true,
156
+
157
+ // Opens links in an iframe preview overlay
158
+ previewLinks: false,
159
+
160
+ // Transition style
161
+ transition: 'default', // none/fade/slide/convex/concave/zoom
162
+
163
+ // Transition speed
164
+ transitionSpeed: 'default', // default/fast/slow
165
+
166
+ // Transition style for full page slide backgrounds
167
+ backgroundTransition: 'default', // none/fade/slide/convex/concave/zoom
168
+
169
+ // Number of slides away from the current that are visible
170
+ viewDistance: 3,
171
+
172
+ // Parallax background image
173
+ parallaxBackgroundImage: '', // e.g. "'https://s3.amazonaws.com/hakim-static/reveal-js/reveal-parallax-1.jpg'"
174
+
175
+ // Parallax background size
176
+ parallaxBackgroundSize: '' // CSS syntax, e.g. "2100px 900px"
177
+
178
+
179
+ });
180
+ ```
181
+
182
+
183
+ The configuration can be updated after initialization using the ```configure``` method:
184
+
185
+ ```javascript
186
+ // Turn autoSlide off
187
+ Reveal.configure({ autoSlide: 0 });
188
+
189
+ // Start auto-sliding every 5s
190
+ Reveal.configure({ autoSlide: 5000 });
191
+ ```
192
+
193
+
194
+ ### Dependencies
195
+
196
+ Reveal.js doesn't _rely_ on any third party scripts to work but a few optional libraries are included by default. These libraries are loaded as dependencies in the order they appear, for example:
197
+
198
+ ```javascript
199
+ Reveal.initialize({
200
+ dependencies: [
201
+ // Cross-browser shim that fully implements classList - https://github.com/eligrey/classList.js/
202
+ { src: 'lib/js/classList.js', condition: function() { return !document.body.classList; } },
203
+
204
+ // Interpret Markdown in <section> elements
205
+ { src: 'plugin/markdown/marked.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },
206
+ { src: 'plugin/markdown/markdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },
207
+
208
+ // Syntax highlight for <code> elements
209
+ { src: 'plugin/highlight/highlight.js', async: true, callback: function() { hljs.initHighlightingOnLoad(); } },
210
+
211
+ // Zoom in and out with Alt+click
212
+ { src: 'plugin/zoom-js/zoom.js', async: true },
213
+
214
+ // Speaker notes
215
+ { src: 'plugin/notes/notes.js', async: true },
216
+
217
+ // Remote control your reveal.js presentation using a touch device
218
+ { src: 'plugin/remotes/remotes.js', async: true },
219
+
220
+ // MathJax
221
+ { src: 'plugin/math/math.js', async: true }
222
+ ]
223
+ });
224
+ ```
225
+
226
+ You can add your own extensions using the same syntax. The following properties are available for each dependency object:
227
+ - **src**: Path to the script to load
228
+ - **async**: [optional] Flags if the script should load after reveal.js has started, defaults to false
229
+ - **callback**: [optional] Function to execute when the script has loaded
230
+ - **condition**: [optional] Function which must return true for the script to be loaded
231
+
232
+
233
+ ### Presentation Size
234
+
235
+ All presentations have a normal size, that is the resolution at which they are authored. The framework will automatically scale presentations uniformly based on this size to ensure that everything fits on any given display or viewport.
236
+
237
+ See below for a list of configuration options related to sizing, including default values:
238
+
239
+ ```javascript
240
+ Reveal.initialize({
241
+
242
+ ...
243
+
244
+ // The "normal" size of the presentation, aspect ratio will be preserved
245
+ // when the presentation is scaled to fit different resolutions. Can be
246
+ // specified using percentage units.
247
+ width: 960,
248
+ height: 700,
249
+
250
+ // Factor of the display size that should remain empty around the content
251
+ margin: 0.1,
252
+
253
+ // Bounds for smallest/largest possible scale to apply to content
254
+ minScale: 0.2,
255
+ maxScale: 1.0
256
+
257
+ });
258
+ ```
259
+
260
+
261
+ ### Auto-sliding
262
+
263
+ Presentations can be configure to progress through slides automatically, without any user input. To enable this you will need to tell the framework how many milliseconds it should wait between slides:
264
+
265
+ ```javascript
266
+ // Slide every five seconds
267
+ Reveal.configure({
268
+ autoSlide: 5000
269
+ });
270
+ ```
271
+ When this is turned on a control element will appear that enables users to pause and resume auto-sliding. Alternatively, sliding can be paused or resumed by pressing »a« on the keyboard. Sliding is paused automatically as soon as the user starts navigating. You can disable these controls by specifying ```autoSlideStoppable: false``` in your reveal.js config.
272
+
273
+ You can also override the slide duration for individual slides and fragments by using the ```data-autoslide``` attribute:
274
+
275
+ ```html
276
+ <section data-autoslide="2000">
277
+ <p>After 2 seconds the first fragment will be shown.</p>
278
+ <p class="fragment" data-autoslide="10000">After 10 seconds the next fragment will be shown.</p>
279
+ <p class="fragment">Now, the fragment is displayed for 2 seconds before the next slide is shown.</p>
280
+ </section>
281
+ ```
282
+
283
+ Whenever the auto-slide mode is resumed or paused the ```autoslideresumed``` and ```autoslidepaused``` events are fired.
284
+
285
+
286
+ ### Keyboard Bindings
287
+
288
+ If you're unhappy with any of the default keyboard bindings you can override them using the ```keyboard``` config option:
289
+
290
+ ```javascript
291
+ Reveal.configure({
292
+ keyboard: {
293
+ 13: 'next', // go to the next slide when the ENTER key is pressed
294
+ 27: function() {}, // do something custom when ESC is pressed
295
+ 32: null // don't do anything when SPACE is pressed (i.e. disable a reveal.js default binding)
296
+ }
297
+ });
298
+ ```
299
+
300
+ ### Lazy Loading
301
+
302
+ When working on presentation with a lot of media or iframe content it's important to load lazily. Lazy loading means that reveal.js will only load content for the few slides nearest to the current slide. The number of slides that are preloaded is determined by the `viewDistance` configuration option.
303
+
304
+ To enable lazy loading all you need to do is change your "src" attributes to "data-src" as shown below. This is supported for image, video, audio and iframe elements.
305
+
306
+ ```html
307
+ <section>
308
+ <img data-src="image.png">
309
+ <iframe data-src="http://slides.com">
310
+ <video>
311
+ <source data-src="video.webm" type="video/webm" />
312
+ <source data-src="video.mp4" type="video/mp4" />
313
+ </video>
314
+ </section>
315
+ ```
316
+
317
+
318
+ ### API
319
+
320
+ The ``Reveal`` class provides a JavaScript API for controlling navigation and reading state:
321
+
322
+ ```javascript
323
+ // Navigation
324
+ Reveal.slide( indexh, indexv, indexf );
325
+ Reveal.left();
326
+ Reveal.right();
327
+ Reveal.up();
328
+ Reveal.down();
329
+ Reveal.prev();
330
+ Reveal.next();
331
+ Reveal.prevFragment();
332
+ Reveal.nextFragment();
333
+ Reveal.toggleOverview();
334
+ Reveal.togglePause();
335
+ Reveal.toggleAutoSlide();
336
+
337
+ // Retrieves the previous and current slide elements
338
+ Reveal.getPreviousSlide();
339
+ Reveal.getCurrentSlide();
340
+
341
+ Reveal.getIndices(); // { h: 0, v: 0 } }
342
+
343
+ // State checks
344
+ Reveal.isFirstSlide();
345
+ Reveal.isLastSlide();
346
+ Reveal.isOverview();
347
+ Reveal.isPaused();
348
+ Reveal.isAutoSliding();
349
+ ```
350
+
351
+ ### Ready Event
352
+
353
+ The 'ready' event is fired when reveal.js has loaded all (synchronous) dependencies and is ready to start navigating.
354
+
355
+ ```javascript
356
+ Reveal.addEventListener( 'ready', function( event ) {
357
+ // event.currentSlide, event.indexh, event.indexv
358
+ } );
359
+ ```
360
+
361
+ ### Slide Changed Event
362
+
363
+ An 'slidechanged' event is fired each time the slide is changed (regardless of state). The event object holds the index values of the current slide as well as a reference to the previous and current slide HTML nodes.
364
+
365
+ Some libraries, like MathJax (see [#226](https://github.com/hakimel/reveal.js/issues/226#issuecomment-10261609)), get confused by the transforms and display states of slides. Often times, this can be fixed by calling their update or render function from this callback.
366
+
367
+ ```javascript
368
+ Reveal.addEventListener( 'slidechanged', function( event ) {
369
+ // event.previousSlide, event.currentSlide, event.indexh, event.indexv
370
+ } );
371
+ ```
372
+
373
+
374
+ ### States
375
+
376
+ If you set ``data-state="somestate"`` on a slide ``<section>``, "somestate" will be applied as a class on the document element when that slide is opened. This allows you to apply broad style changes to the page based on the active slide.
377
+
378
+ Furthermore you can also listen to these changes in state via JavaScript:
379
+
380
+ ```javascript
381
+ Reveal.addEventListener( 'somestate', function() {
382
+ // TODO: Sprinkle magic
383
+ }, false );
384
+ ```
385
+
386
+ ### Slide Backgrounds
387
+
388
+ Slides are contained within a limited portion of the screen by default to allow them to fit any display and scale uniformly. You can apply full page backgrounds outside of the slide area by adding a ```data-background``` attribute to your ```<section>``` elements. Four different types of backgrounds are supported: color, image, video and iframe. Below are a few examples.
389
+
390
+ ```html
391
+ <section data-background="#ff0000">
392
+ <h2>All CSS color formats are supported, like rgba() or hsl().</h2>
393
+ </section>
394
+ <section data-background="http://example.com/image.png">
395
+ <h2>This slide will have a full-size background image.</h2>
396
+ </section>
397
+ <section data-background="http://example.com/image.png" data-background-size="100px" data-background-repeat="repeat">
398
+ <h2>This background image will be sized to 100px and repeated.</h2>
399
+ </section>
400
+ <section data-background-video="https://s3.amazonaws.com/static.slid.es/site/homepage/v1/homepage-video-editor.mp4,https://s3.amazonaws.com/static.slid.es/site/homepage/v1/homepage-video-editor.webm">
401
+ <h2>Video. Multiple sources can be defined using a comma separated list.</h2>
402
+ </section>
403
+ <section data-background-iframe="https://slides.com">
404
+ <h2>Embeds a web page as a background. Note that the page won't be interactive.</h2>
405
+ </section>
406
+ ```
407
+
408
+ Backgrounds transition using a fade animation by default. This can be changed to a linear sliding transition by passing ```backgroundTransition: 'slide'``` to the ```Reveal.initialize()``` call. Alternatively you can set ```data-background-transition``` on any section with a background to override that specific transition.
409
+
410
+
411
+ ### Parallax Background
412
+
413
+ If you want to use a parallax scrolling background, set the two following config properties when initializing reveal.js (the third one is optional).
414
+
415
+ ```javascript
416
+ Reveal.initialize({
417
+
418
+ // Parallax background image
419
+ parallaxBackgroundImage: '', // e.g. "https://s3.amazonaws.com/hakim-static/reveal-js/reveal-parallax-1.jpg"
420
+
421
+ // Parallax background size
422
+ parallaxBackgroundSize: '', // CSS syntax, e.g. "2100px 900px" - currently only pixels are supported (don't use % or auto)
423
+
424
+ // This slide transition gives best results:
425
+ transition: 'slide'
426
+
427
+ });
428
+ ```
429
+
430
+ Make sure that the background size is much bigger than screen size to allow for some scrolling. [View example](http://lab.hakim.se/reveal-js/?parallaxBackgroundImage=https%3A%2F%2Fs3.amazonaws.com%2Fhakim-static%2Freveal-js%2Freveal-parallax-1.jpg&parallaxBackgroundSize=2100px%20900px).
431
+
432
+
433
+
434
+ ### Slide Transitions
435
+ The global presentation transition is set using the ```transition``` config value. You can override the global transition for a specific slide by using the ```data-transition``` attribute:
436
+
437
+ ```html
438
+ <section data-transition="zoom">
439
+ <h2>This slide will override the presentation transition and zoom!</h2>
440
+ </section>
441
+
442
+ <section data-transition-speed="fast">
443
+ <h2>Choose from three transition speeds: default, fast or slow!</h2>
444
+ </section>
445
+ ```
446
+
447
+ Note that this does not work with the page and cube transitions.
448
+
449
+
450
+ ### Internal links
451
+
452
+ It's easy to link between slides. The first example below targets the index of another slide whereas the second targets a slide with an ID attribute (```<section id="some-slide">```):
453
+
454
+ ```html
455
+ <a href="#/2/2">Link</a>
456
+ <a href="#/some-slide">Link</a>
457
+ ```
458
+
459
+ You can also add relative navigation links, similar to the built in reveal.js controls, by appending one of the following classes on any element. Note that each element is automatically given an ```enabled``` class when it's a valid navigation route based on the current slide.
460
+
461
+ ```html
462
+ <a href="#" class="navigate-left">
463
+ <a href="#" class="navigate-right">
464
+ <a href="#" class="navigate-up">
465
+ <a href="#" class="navigate-down">
466
+ <a href="#" class="navigate-prev"> <!-- Previous vertical or horizontal slide -->
467
+ <a href="#" class="navigate-next"> <!-- Next vertical or horizontal slide -->
468
+ ```
469
+
470
+
471
+ ### Fragments
472
+ Fragments are used to highlight individual elements on a slide. Every element with the class ```fragment``` will be stepped through before moving on to the next slide. Here's an example: http://lab.hakim.se/reveal-js/#/fragments
473
+
474
+ The default fragment style is to start out invisible and fade in. This style can be changed by appending a different class to the fragment:
475
+
476
+ ```html
477
+ <section>
478
+ <p class="fragment grow">grow</p>
479
+ <p class="fragment shrink">shrink</p>
480
+ <p class="fragment roll-in">roll-in</p>
481
+ <p class="fragment fade-out">fade-out</p>
482
+ <p class="fragment current-visible">visible only once</p>
483
+ <p class="fragment highlight-current-blue">blue only once</p>
484
+ <p class="fragment highlight-red">highlight-red</p>
485
+ <p class="fragment highlight-green">highlight-green</p>
486
+ <p class="fragment highlight-blue">highlight-blue</p>
487
+ </section>
488
+ ```
489
+
490
+ Multiple fragments can be applied to the same element sequentially by wrapping it, this will fade in the text on the first step and fade it back out on the second.
491
+
492
+ ```html
493
+ <section>
494
+ <span class="fragment fade-in">
495
+ <span class="fragment fade-out">I'll fade in, then out</span>
496
+ </span>
497
+ </section>
498
+ ```
499
+
500
+ The display order of fragments can be controlled using the ```data-fragment-index``` attribute.
501
+
502
+ ```html
503
+ <section>
504
+ <p class="fragment" data-fragment-index="3">Appears last</p>
505
+ <p class="fragment" data-fragment-index="1">Appears first</p>
506
+ <p class="fragment" data-fragment-index="2">Appears second</p>
507
+ </section>
508
+ ```
509
+
510
+ ### Fragment events
511
+
512
+ When a slide fragment is either shown or hidden reveal.js will dispatch an event.
513
+
514
+ Some libraries, like MathJax (see #505), get confused by the initially hidden fragment elements. Often times this can be fixed by calling their update or render function from this callback.
515
+
516
+ ```javascript
517
+ Reveal.addEventListener( 'fragmentshown', function( event ) {
518
+ // event.fragment = the fragment DOM element
519
+ } );
520
+ Reveal.addEventListener( 'fragmenthidden', function( event ) {
521
+ // event.fragment = the fragment DOM element
522
+ } );
523
+ ```
524
+
525
+ ### Code syntax highlighting
526
+
527
+ By default, Reveal is configured with [highlight.js](http://softwaremaniacs.org/soft/highlight/en/) 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.
528
+
529
+ ```html
530
+ <section>
531
+ <pre><code data-trim>
532
+ (def lazy-fib
533
+ (concat
534
+ [0 1]
535
+ ((fn rfib [a b]
536
+ (lazy-cons (+ a b) (rfib b (+ a b)))) 0 1)))
537
+ </code></pre>
538
+ </section>
539
+ ```
540
+
541
+ ### Slide number
542
+ If you would like to display the page number of the current slide you can do so using the ```slideNumber``` configuration value.
543
+
544
+ ```javascript
545
+ Reveal.configure({ slideNumber: true });
546
+ ```
547
+
548
+
549
+ ### Overview mode
550
+
551
+ Press "Esc" or "o" keys to toggle the overview mode on and off. While you're in this mode, you can still navigate between slides,
552
+ as if you were at 1,000 feet above your presentation. The overview mode comes with a few API hooks:
553
+
554
+ ```javascript
555
+ Reveal.addEventListener( 'overviewshown', function( event ) { /* ... */ } );
556
+ Reveal.addEventListener( 'overviewhidden', function( event ) { /* ... */ } );
557
+
558
+ // Toggle the overview mode programmatically
559
+ Reveal.toggleOverview();
560
+ ```
561
+
562
+ ### Fullscreen mode
563
+ Just press »F« on your keyboard to show your presentation in fullscreen mode. Press the »ESC« key to exit fullscreen mode.
564
+
565
+
566
+ ### Embedded media
567
+ Embedded HTML5 `<video>`/`<audio>` and YouTube iframes are automatically paused when you navigate away from a slide. This can be disabled by decorating your element with a `data-ignore` attribute.
568
+
569
+ Add `data-autoplay` to your media element if you want it to automatically start playing when the slide is shown:
570
+
571
+ ```html
572
+ <video data-autoplay src="http://clips.vorwaerts-gmbh.de/big_buck_bunny.mp4"></video>
573
+ ```
574
+
575
+ Additionally the framework automatically pushes two [post messages](https://developer.mozilla.org/en-US/docs/Web/API/Window.postMessage) to all iframes, ```slide:start``` when the slide containing the iframe is made visible and ```slide:stop``` when it is hidden.
576
+
577
+
578
+ ### Stretching elements
579
+ Sometimes it's desirable to have an element, like an image or video, stretch to consume as much space as possible within a given slide. This can be done by adding the ```.stretch``` class to an element as seen below:
580
+
581
+ ```html
582
+ <section>
583
+ <h2>This video will use up the remaining space on the slide</h2>
584
+ <video class="stretch" src="http://clips.vorwaerts-gmbh.de/big_buck_bunny.mp4"></video>
585
+ </section>
586
+ ```
587
+
588
+ Limitations:
589
+ - Only direct descendants of a slide section can be stretched
590
+ - Only one descendant per slide section can be stretched
591
+
592
+
593
+ ## PDF Export
594
+
595
+ Presentations can be exported to PDF via a special print stylesheet. This feature requires that you use [Google Chrome](http://google.com/chrome).
596
+ Here's an example of an exported presentation that's been uploaded to SlideShare: http://www.slideshare.net/hakimel/revealjs-300.
597
+
598
+ 1. Open your presentation with `print-pdf` included anywhere in the query string. This triggers the default index HTML to load the PDF print stylesheet ([css/print/pdf.css](https://github.com/hakimel/reveal.js/blob/master/css/print/pdf.css)). You can test this with [lab.hakim.se/reveal-js?print-pdf](http://lab.hakim.se/reveal-js?print-pdf).
599
+ 2. Open the in-browser print dialog (CMD+P).
600
+ 3. Change the **Destination** setting to **Save as PDF**.
601
+ 4. Change the **Layout** to **Landscape**.
602
+ 5. Change the **Margins** to **None**.
603
+ 6. Click **Save**.
604
+
605
+ ![Chrome Print Settings](https://s3.amazonaws.com/hakim-static/reveal-js/pdf-print-settings.png)
606
+
607
+ ## Theming
608
+
609
+ The framework comes with a few different themes included:
610
+
611
+ - black: Black background, white text, blue links (default theme)
612
+ - white: White background, black text, blue links
613
+ - league: Gray background, white text, blue links (default theme for reveal.js < 3.0.0)
614
+ - beige: Beige background, dark text, brown links
615
+ - sky: Blue background, thin white text, blue links
616
+ - night: Black background, thick white text, orange links
617
+ - serif: Cappuccino background, gray text, brown links
618
+ - simple: White background, black text, blue links
619
+ - solarized: Cream-colored background, dark green text, blue links
620
+
621
+ Each theme is available as a separate stylesheet. To change theme you will need to replace **black** below with your desired theme name in index.html:
622
+
623
+ ```html
624
+ <link rel="stylesheet" href="css/theme/black.css" id="theme">
625
+ ```
626
+
627
+ If you want to add a theme of your own see the instructions here: [/css/theme/README.md](https://github.com/hakimel/reveal.js/blob/master/css/theme/README.md).
628
+
629
+
630
+ ## Speaker Notes
631
+
632
+ reveal.js comes with a speaker notes plugin which can be used to present per-slide notes in a separate browser window. The notes window also gives you a preview of the next upcoming slide so it may be helpful even if you haven't written any notes. Press the 's' key on your keyboard to open the notes window.
633
+
634
+ Notes are defined by appending an ```<aside>``` element to a slide as seen below. You can add the ```data-markdown``` attribute to the aside element if you prefer writing notes using Markdown.
635
+
636
+ When used locally, this feature requires that reveal.js [runs from a local web server](#full-setup).
637
+
638
+ ```html
639
+ <section>
640
+ <h2>Some Slide</h2>
641
+
642
+ <aside class="notes">
643
+ Oh hey, these are some notes. They'll be hidden in your presentation, but you can see them if you open the speaker notes window (hit 's' on your keyboard).
644
+ </aside>
645
+ </section>
646
+ ```
647
+
648
+ If you're using the external Markdown plugin, you can add notes with the help of a special delimiter:
649
+
650
+ ```html
651
+ <section data-markdown="example.md" data-separator="^\n\n\n" data-separator-vertical="^\n\n" data-separator-notes="^Note:"></section>
652
+
653
+ # Title
654
+ ## Sub-title
655
+
656
+ Here is some content...
657
+
658
+ Note:
659
+ This will only display in the notes window.
660
+ ```
661
+
662
+ ## Server Side Speaker Notes
663
+
664
+ In some cases it can be desirable to run notes on a separate device from the one you're presenting on. The Node.js-based notes plugin lets you do this using the same note definitions as its client side counterpart. Include the required scripts by adding the following dependencies:
665
+
666
+ ```javascript
667
+ Reveal.initialize({
668
+ ...
669
+
670
+ dependencies: [
671
+ { src: 'socket.io/socket.io.js', async: true },
672
+ { src: 'plugin/notes-server/client.js', async: true }
673
+ ]
674
+ });
675
+ ```
676
+
677
+ Then:
678
+
679
+ 1. Install [Node.js](http://nodejs.org/)
680
+ 2. Run ```npm install```
681
+ 3. Run ```node plugin/notes-server```
682
+
683
+
684
+ ## Multiplexing
685
+
686
+ The multiplex plugin allows your audience to view the slides of the presentation you are controlling on their own phone, tablet or laptop. As the master presentation navigates the slides, all client presentations will update in real time. See a demo at [http://revealjs.jit.su/](http://revealjs.jit.su).
687
+
688
+ The multiplex plugin needs the following 3 things to operate:
689
+
690
+ 1. Master presentation that has control
691
+ 2. Client presentations that follow the master
692
+ 3. Socket.io server to broadcast events from the master to the clients
693
+
694
+ More details:
695
+
696
+ #### Master presentation
697
+ Served from a static file server accessible (preferably) only to the presenter. This need only be on your (the presenter's) computer. (It's safer to run the master presentation from your own computer, so if the venue's Internet goes down it doesn't stop the show.) An example would be to execute the following commands in the directory of your master presentation:
698
+
699
+ 1. ```npm install node-static```
700
+ 2. ```static```
701
+
702
+ If you want to use the speaker notes plugin with your master presentation then make sure you have the speaker notes plugin configured correctly along with the configuration shown below, then execute ```node plugin/notes-server``` in the directory of your master presentation. The configuration below will cause it to connect to the socket.io server as a master, as well as launch your speaker-notes/static-file server.
703
+
704
+ You can then access your master presentation at ```http://localhost:1947```
705
+
706
+ Example configuration:
707
+ ```javascript
708
+ Reveal.initialize({
709
+ // other options...
710
+
711
+ multiplex: {
712
+ // Example values. To generate your own, see the socket.io server instructions.
713
+ secret: '13652805320794272084', // Obtained from the socket.io server. Gives this (the master) control of the presentation
714
+ id: '1ea875674b17ca76', // Obtained from socket.io server
715
+ url: 'revealjs.jit.su:80' // Location of socket.io server
716
+ },
717
+
718
+ // Don't forget to add the dependencies
719
+ dependencies: [
720
+ { src: '//cdnjs.cloudflare.com/ajax/libs/socket.io/0.9.16/socket.io.min.js', async: true },
721
+ { src: 'plugin/multiplex/master.js', async: true },
722
+
723
+ // and if you want speaker notes
724
+ { src: 'plugin/notes-server/client.js', async: true }
725
+
726
+ // other dependencies...
727
+ ]
728
+ });
729
+ ```
730
+
731
+ #### Client presentation
732
+ Served from a publicly accessible static file server. Examples include: GitHub Pages, Amazon S3, Dreamhost, Akamai, etc. The more reliable, the better. Your audience can then access the client presentation via ```http://example.com/path/to/presentation/client/index.html```, with the configuration below causing them to connect to the socket.io server as clients.
733
+
734
+ Example configuration:
735
+ ```javascript
736
+ Reveal.initialize({
737
+ // other options...
738
+
739
+ multiplex: {
740
+ // Example values. To generate your own, see the socket.io server instructions.
741
+ secret: null, // null so the clients do not have control of the master presentation
742
+ id: '1ea875674b17ca76', // id, obtained from socket.io server
743
+ url: 'revealjs.jit.su:80' // Location of socket.io server
744
+ },
745
+
746
+ // Don't forget to add the dependencies
747
+ dependencies: [
748
+ { src: '//cdnjs.cloudflare.com/ajax/libs/socket.io/0.9.16/socket.io.min.js', async: true },
749
+ { src: 'plugin/multiplex/client.js', async: true }
750
+
751
+ // other dependencies...
752
+ ]
753
+ });
754
+ ```
755
+
756
+ #### Socket.io server
757
+ Server that receives the slideChanged events from the master presentation and broadcasts them out to the connected client presentations. This needs to be publicly accessible. You can run your own socket.io server with the commands:
758
+
759
+ 1. ```npm install```
760
+ 2. ```node plugin/multiplex```
761
+
762
+ Or you use the socket.io server at [http://revealjs.jit.su](http://revealjs.jit.su).
763
+
764
+ You'll need to generate a unique secret and token pair for your master and client presentations. To do so, visit ```http://example.com/token```, where ```http://example.com``` is the location of your socket.io server. Or if you're going to use the socket.io server at [http://revealjs.jit.su](http://revealjs.jit.su), visit [http://revealjs.jit.su/token](http://revealjs.jit.su/token).
765
+
766
+ You are very welcome to point your presentations at the Socket.io server running at [http://revealjs.jit.su](http://revealjs.jit.su), but availability and stability are not guaranteed. For anything mission critical I recommend you run your own server. It is simple to deploy to nodejitsu, heroku, your own environment, etc.
767
+
768
+ ##### socket.io server as file static server
769
+
770
+ The socket.io server can play the role of static file server for your client presentation, as in the example at [http://revealjs.jit.su](http://revealjs.jit.su). (Open [http://revealjs.jit.su](http://revealjs.jit.su) in two browsers. Navigate through the slides on one, and the other will update to match.)
771
+
772
+ Example configuration:
773
+ ```javascript
774
+ Reveal.initialize({
775
+ // other options...
776
+
777
+ multiplex: {
778
+ // Example values. To generate your own, see the socket.io server instructions.
779
+ secret: null, // null so the clients do not have control of the master presentation
780
+ id: '1ea875674b17ca76', // id, obtained from socket.io server
781
+ url: 'example.com:80' // Location of your socket.io server
782
+ },
783
+
784
+ // Don't forget to add the dependencies
785
+ dependencies: [
786
+ { src: '//cdnjs.cloudflare.com/ajax/libs/socket.io/0.9.16/socket.io.min.js', async: true },
787
+ { src: 'plugin/multiplex/client.js', async: true }
788
+
789
+ // other dependencies...
790
+ ]
791
+ ```
792
+
793
+ It can also play the role of static file server for your master presentation and client presentations at the same time (as long as you don't want to use speaker notes). (Open [http://revealjs.jit.su](http://revealjs.jit.su) in two browsers. Navigate through the slides on one, and the other will update to match. Navigate through the slides on the second, and the first will update to match.) This is probably not desirable, because you don't want your audience to mess with your slides while you're presenting. ;)
794
+
795
+ Example configuration:
796
+ ```javascript
797
+ Reveal.initialize({
798
+ // other options...
799
+
800
+ multiplex: {
801
+ // Example values. To generate your own, see the socket.io server instructions.
802
+ secret: '13652805320794272084', // Obtained from the socket.io server. Gives this (the master) control of the presentation
803
+ id: '1ea875674b17ca76', // Obtained from socket.io server
804
+ url: 'example.com:80' // Location of your socket.io server
805
+ },
806
+
807
+ // Don't forget to add the dependencies
808
+ dependencies: [
809
+ { src: '//cdnjs.cloudflare.com/ajax/libs/socket.io/0.9.16/socket.io.min.js', async: true },
810
+ { src: 'plugin/multiplex/master.js', async: true },
811
+ { src: 'plugin/multiplex/client.js', async: true }
812
+
813
+ // other dependencies...
814
+ ]
815
+ });
816
+ ```
817
+
818
+ ## Leap Motion
819
+ The Leap Motion plugin lets you utilize your [Leap Motion](https://www.leapmotion.com/) device to control basic navigation of your presentation. The gestures currently supported are:
820
+
821
+ ##### 1 to 2 fingers
822
+ Pointer &mdash; Point to anything on screen. Move your finger past the device to expand the pointer.
823
+
824
+ ##### 1 hand + 3 or more fingers (left/right/up/down)
825
+ Navigate through your slides. See config options to invert movements.
826
+
827
+ ##### 2 hands upwards
828
+ Toggle the overview mode. Do it a second time to exit the overview.
829
+
830
+ #### Config Options
831
+ You can edit the following options:
832
+
833
+ | Property | Default | Description
834
+ | ----------------- |:-----------------:| :-------------
835
+ | autoCenter | true | Center the pointer based on where you put your finger into the leap motions detection field.
836
+ | gestureDelay | 500 | How long to delay between gestures in milliseconds.
837
+ | naturalSwipe | true | Swipe as though you were touching a touch screen. Set to false to invert.
838
+ | pointerColor | #00aaff | The color of the pointer.
839
+ | pointerOpacity | 0.7 | The opacity of the pointer.
840
+ | pointerSize | 15 | The minimum height and width of the pointer.
841
+ | pointerTolerance | 120 | Bigger = slower pointer.
842
+
843
+
844
+ Example configuration:
845
+ ```js
846
+ Reveal.initialize({
847
+
848
+ // other options...
849
+
850
+ leap: {
851
+ naturalSwipe : false, // Invert swipe gestures
852
+ pointerOpacity : 0.5, // Set pointer opacity to 0.5
853
+ pointerColor : '#d80000' // Red pointer
854
+ },
855
+
856
+ dependencies: [
857
+ { src: 'plugin/leap/leap.js', async: true }
858
+ ]
859
+
860
+ });
861
+ ```
862
+
863
+ ## MathJax
864
+
865
+ If you want to display math equations in your presentation you can easily do so by including this plugin. The plugin is a very thin wrapper around the [MathJax](http://www.mathjax.org/) library. To use it you'll need to include it as a reveal.js dependency, [find our more about dependencies here](#dependencies).
866
+
867
+ The plugin defaults to using [LaTeX](http://en.wikipedia.org/wiki/LaTeX) but that can be adjusted through the ```math``` configuration object. Note that MathJax is loaded from a remote server. If you want to use it offline you'll need to download a copy of the library and adjust the ```mathjax``` configuration value.
868
+
869
+ Below is an example of how the plugin can be configured. If you don't intend to change these values you do not need to include the ```math``` config object at all.
870
+
871
+ ```js
872
+ Reveal.initialize({
873
+
874
+ // other options ...
875
+
876
+ math: {
877
+ mathjax: 'http://cdn.mathjax.org/mathjax/latest/MathJax.js',
878
+ config: 'TeX-AMS_HTML-full' // See http://docs.mathjax.org/en/latest/config-files.html
879
+ },
880
+
881
+ dependencies: [
882
+ { src: 'plugin/math/math.js', async: true }
883
+ ]
884
+
885
+ });
886
+ ```
887
+
888
+ Read MathJax's documentation if you need [HTTPS delivery](http://docs.mathjax.org/en/latest/start.html#secure-access-to-the-cdn) or serving of [specific versions](http://docs.mathjax.org/en/latest/configuration.html#loading-mathjax-from-the-cdn) for stability.
889
+
890
+
891
+ ## Installation
892
+
893
+ The **basic setup** is for authoring presentations only. The **full setup** gives you access to all reveal.js features and plugins such as speaker notes as well as the development tasks needed to make changes to the source.
894
+
895
+ ### Basic setup
896
+
897
+ The core of reveal.js is very easy to install. You'll simply need to download a copy of this repository and open the index.html file directly in your browser.
898
+
899
+ 1. Download the latest version of reveal.js from <https://github.com/hakimel/reveal.js/releases>
900
+
901
+ 2. Unzip and replace the example contents in index.html with your own
902
+
903
+ 3. Open index.html in a browser to view it
904
+
905
+
906
+ ### Full setup
907
+
908
+ Some reveal.js features, like external Markdown and speaker notes, require that presentations run from a local web server. The following instructions will set up such a server as well as all of the development tasks needed to make edits to the reveal.js source code.
909
+
910
+ 1. Install [Node.js](http://nodejs.org/)
911
+
912
+ 2. Install [Grunt](http://gruntjs.com/getting-started#installing-the-cli)
913
+
914
+ 4. Clone the reveal.js repository
915
+ ```sh
916
+ $ git clone https://github.com/hakimel/reveal.js.git
917
+ ```
918
+
919
+ 5. Navigate to the reveal.js folder
920
+ ```sh
921
+ $ cd reveal.js
922
+ ```
923
+
924
+ 6. Install dependencies
925
+ ```sh
926
+ $ npm install
927
+ ```
928
+
929
+ 7. Serve the presentation and monitor source files for changes
930
+ ```sh
931
+ $ grunt serve
932
+ ```
933
+
934
+ 8. Open <http://localhost:8000> to view your presentation
935
+
936
+ You can change the port by using `grunt serve --port 8001`.
937
+
938
+
939
+ ### Folder Structure
940
+ - **css/** Core styles without which the project does not function
941
+ - **js/** Like above but for JavaScript
942
+ - **plugin/** Components that have been developed as extensions to reveal.js
943
+ - **lib/** All other third party assets (JavaScript, CSS, fonts)
944
+
945
+
946
+ ## License
947
+
948
+ MIT licensed
949
+
950
+ Copyright (C) 2015 Hakim El Hattab, http://hakim.se