rjsmake
rjsmake copied to clipboard
Use Markdown to generate a Reveal.js presentation in minutes.
rjsmake
Automating Reveal.js presentation builds with Markdown, Pandoc, and Make.
Reveal.js simplifies creating presentations, but you still have to write all of that HTML. Pandoc comes to your rescue by allowing you to create the content in Markdown. Rjsmake provides a standardized structure and build process.
Advantages:
- Create a presentation in minutes from Markdown.
- Store only the presentation source in your repository.
- Provides simplified subset of full Reveal.js feature set.
Disadvantage:
- Provides simplified subset of full Reveal.js feature set.
Basic Use
- Download the repository ZIP.
- Edit the
index.md - Build the presentation by typing
make - Load
index.htmlin a web browser.
Iterate on the index.md file by running watch make.
Pandoc enhanced Markdown:
# - New Horizontal Page w/title
## - New Vertical Page w/title
---------- = New Horizontal Page w/o Title
. . . = Three dots separated by spaces creates a pause within Page

* Unordered
* List
- Unordered
- List
1. Ordered
2. List
```bash
ls -l # Code
```
Setup Instructions
Rjsmake requires Pandoc and Make.
Pandoc is best installed by following the instructions available on the Pandoc install page. There are installers for Linux, OSX, and Windows.
Linux
Debian/Ubuntu based distributions:
- Run:
sudo apt-get install make curl tar - Install the
PandocDEB: http://pandoc.org/installing.html
OS X
- Install Xcode Command Line Tools to get
Make. - Install the
PandocPKG: http://pandoc.org/installing.html - Optional: Install
watchusing homebrew:brew install watch
Windows
- GNU Make: https://chocolatey.org/packages/make
- The
PandocMSI: http://pandoc.org/installing.html - Further details TBD
Examples
The example/basic directory showcases the above feature set.
Helpful links:
- http://pandoc.org/README.html#producing-slide-shows-with-pandoc