reveal.js on steroids! Get beautiful reveal.js presentations from your Markdown files.
This repository is a fork of abelnation/reveal-md.
Thanks to @abelnation to add code highlight on his fork of the original project webpro/reveal-md.
Create a sym link to you local bin version:
sudo ln -s /path/to/you/clone/repo/reveal-md/bin/server-cli.js /usr/local/bin/reveal-mdc
Execute your local version passing the path of your *.md file:
reveal-mdc path/to/README.md
The Markdown feature of reveal.js is awesome, and has an easy (and configurable) syntax to separate slides.
Use three dashes surrounded by two blank lines (\n---\n
).
Example:
# Title
* Point 1
* Point 2
---
## Second slide
> Best quote ever.
The separator syntax can be overriden (e.g. I like to use three blank lines).
To open specific Markdown file as Reveal.js slideshow:
reveal-md slides.md
You can also provide a url that resolves to a Markdown resource (over http(s)).
reveal-md https://raw.github.com/webpro/reveal-md/master/demo/a.md
Show (recursive) directory listing of Markdown files:
reveal-md dir/
Show directory listing of Markdown files in current directory:
reveal-md
Override theme (default: default
):
reveal-md slides.md --theme solarized
Override slide separator (default: \n---\n
):
reveal-md slides.md --separator "^\n\n\n"
Override vertical/nested slide separator (default: \n----\n
):
reveal-md slides.md --vertical "^\n\n"
Override port (default: 1948
):
reveal-md slides.md --port 8888
Requires phantomjs to be installed (preferably globally)
This will try to create a pdf with the passed in file (eg slides.md) and outputted to the name passed into the --print
parameter (eg slides.pdf)
reveal-md slides.md --print slides.pdf
reveal-md
always starts a local server and opens the default browser- From any presentation, navigate to the root (e.g. http://localhost:1948) to get directory listing of (linked) Markdown files. Root folder is resolved from Markdown file (or directory)
reveal-md
was started with.