{"name":"reveal.js","tagline":"The HTML Presentation Framework","body":"# reveal.js [](https://travis-ci.org/hakimel/reveal.js)\r\n\r\nA framework for easily creating beautiful presentations using HTML. [Check out the live demo](http://lab.hakim.se/reveal-js/).\r\n\r\nreveal.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 browser with support for CSS 3D transforms but [fallbacks](https://github.com/hakimel/reveal.js/wiki/Browser-Support) are available to make sure your presentation can still be viewed elsewhere.\r\n\r\n\r\n#### More reading:\r\n- [Installation](#installation): Step-by-step instructions for getting reveal.js running on your computer.\r\n- [Changelog](https://github.com/hakimel/reveal.js/releases): Up-to-date version history.\r\n- [Examples](https://github.com/hakimel/reveal.js/wiki/Example-Presentations): Presentations created with reveal.js, add your own!\r\n- [Browser Support](https://github.com/hakimel/reveal.js/wiki/Browser-Support): Explanation of browser support and fallbacks.\r\n\r\n## Slides\r\n\r\nPresentations 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://slid.es](http://slid.es).\r\n\r\n\r\n## Instructions\r\n\r\n### Markup\r\n\r\nMarkup 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:\r\n\r\n```html\r\n<div class=\"reveal\">\r\n\t<div class=\"slides\">\r\n\t\t<section>Single Horizontal Slide</section>\r\n\t\t<section>\r\n\t\t\t<section>Vertical Slide 1</section>\r\n\t\t\t<section>Vertical Slide 2</section>\r\n\t\t</section>\r\n\t</div>\r\n</div>\r\n```\r\n\r\n### Markdown\r\n\r\nIt'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.\r\n\r\nThis 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).\r\n\r\n```html\r\n<section data-markdown>\r\n\t<script type=\"text/template\">\r\n\t\t## Page title\r\n\r\n\t\tA paragraph with some text and a [link](http://hakim.se).\r\n\t</script>\r\n</section>\r\n```\r\n\r\n#### External Markdown\r\n\r\nYou 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.\r\n\r\n```html\r\n<section data-markdown=\"example.md\" data-separator=\"^\\n\\n\\n\" data-vertical=\"^\\n\\n\"></section>\r\n```\r\n\r\n###Configuration\r\n\r\nAttheendofyourpageyouneedtoinitializerevealbyrunningthefollowingcode.Notethatallconfigvaluesareoptionalandwilldefaultasspecifiedbelow.\r\n\r\n```javascript\r\nReveal.initialize({\r\n\r\n\t//Displaycontrolsinthebottomrightcorner\r\n\tcontrols:true,\r\n\r\n\t//Displayapresentationprogressbar\r\n\tprogress:true,\r\n\r\n\t//Pusheachslidechangetothebrowserhistory\r\n\thistory:false,\r\n\r\n\t//Enablekeyboardshortcutsfornavigation\r\
