Skip to content
/ rsttools Public

ReStructuredText (ReST) HTML slide generator for reveal.js

License

Notifications You must be signed in to change notification settings

httk/rsttools

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

56 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

httk-rsttools

This repository is a side repository to httk to support various forms of information publishing. Presently, the only components are rstslide and rstpaper.

rstslide: reStructuredText HTML slide generator using reveal.js

rstslide forks rst2reveal from https://github.com/vitay/rst2reveal

rstslide transforms reStructuredText (ReST) text files to HTML5 slides that uses the Reveal.js Javascript library developped by Hakim El Hattab.

Dependencies

In addition to Python 2.6 or 2.7 (not 3.x yet), rstslide requires the following packages:

If you want to display code in your slides, it is strongly advised to have pygments installed for syntaxic color highlighting in many languages.

To directly generate plots within the ReST script, you will need Matplotlib (version >= 1.1) installed.

Installation

Simply clone the git repository and run make:

$ git clone https://github.com/rartino/rstslide.git
$ cd rstslide
$ make

and then add the bin directory to your path.

rstslide has been tested only on GNU/Linux systems, but perhaps it works on other platforms.

Usage

You can go in the docs/ subfolder and compile the presentation:

cd docs/
rstslide presentation.conf

Command-line options

You can get a summary of command-line options by typing:

rstslide --help