Document optional libraries

Note that socket.io and a few others are not shipped by default
This commit is contained in:
Dan Dascalescu 2012-08-14 18:09:28 -07:00
parent d0e6e95781
commit 8b00c975e4

View File

@ -87,8 +87,17 @@ Reveal.js doesn't _rely_ on any third party scripts to work but a few optional l
```javascript ```javascript
Reveal.initialize({ Reveal.initialize({
dependencies: [ dependencies: [
// syntax highlight for <code> sections
{ src: 'lib/js/highlight.js', async: true, callback: function() { window.hljs.initHighlightingOnLoad(); } }, { 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; } } { 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'; } },
] ]
}); });
``` ```