From 8b00c975e46b34af5ca208b030422495630e65ef Mon Sep 17 00:00:00 2001 From: Dan Dascalescu Date: Tue, 14 Aug 2012 18:09:28 -0700 Subject: [PATCH] Document optional libraries Note that socket.io and a few others are not shipped by default --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 12b931fd..566a652e 100644 --- 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 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
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'; } }, ] }); ```