update nbconvert docs about reveal.js

This commit is contained in:
MinRK 2013-08-16 11:35:47 -07:00
parent 5e590218f2
commit 398a2d1da3

View File

@ -63,11 +63,21 @@ The currently supported export formats are:
This generates a Reveal.js HTML slideshow.
It must be served by an HTTP server. The easiest way to get this is to add
``--post serve`` on the command-line.
If you want to use the speaker notes plugin, just add
``--slide-notes=True`` on the command-line.
For low connectivity environments, you can use a local copy of the reveal.js library,
just add ``--offline-slides=reveal.js`` on the command-line, and do not forget to move
your downloaded ``reveal.js`` library to the same folder where your slides are located.
For low connectivity environments, you can use a local copy of the reveal.js library.
This can be any relative URL, ``reveal.js`` being most likely.
Do not forget to move your downloaded ``reveal.js`` library to the same folder where your slides are located.
Fetching the latest reveal.js from GitHub:
.. sourcecode: bash
curl -L https://github.com/hakimel/reveal.js/archive/master.tar.gz | tar -xzf -
mv reveal.js-master reveal.js
ipython nbconvert mynotebook --to slides --reveal-prefix=reveal.js
.. note::
If you want to use the speaker notes plugin, you must use a local reveal.js copy
* ``--to markdown``