Document optional libraries
authorDan Dascalescu <ddascalescu+github@gmail.com>
Wed, 15 Aug 2012 01:09:28 +0000 (18:09 -0700)
committerDan Dascalescu <ddascalescu+github@gmail.com>
Wed, 15 Aug 2012 01:09:28 +0000 (18:09 -0700)
Note that socket.io and a few others are not shipped by default

README.md

index 12b931fdc84d1795e3edab5d4485cc3b0caa4ece..566a652eb5dfc9f5eefab834752c6fb76bd7e8ad 100644 (file)
--- a/README.md
+++ b/README.md
@@ -87,8 +87,17 @@ Reveal.js doesn't _rely_ on any third party scripts to work but a few optional l
 ```javascript
 Reveal.initialize({
        dependencies: [
+               // syntax highlight for <code> sections
                { src: 'lib/js/highlight.js', async: true, callback: function() { window.hljs.initHighlightingOnLoad(); } },
+               // cross-browser shim that fully implements classList - https://github.com/eligrey/classList.js/
                { src: 'lib/js/classList.js', condition: function() { return !document.body.classList; } }
+               // interpret Markdown in <section> elements
+               { src: 'lib/js/data-markdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },
+               { src: 'lib/js/showdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },
+               // speaker notes support
+               { src: 'plugin/speakernotes/client.js', async: true, condition: function() { return window.location.host === 'localhost:1947'; } },
+               // required by speakernotes
+               { src: 'socket.io/socket.io.js', async: true, condition: function() { return window.location.host === 'localhost:1947'; } },
        ]
 });
 ```