Skip to content

revealjs workflow automation: reveal.js + external markdown mixed with some bash awesomeness to automate routine presentation tasks

License

Notifications You must be signed in to change notification settings

anantshri/present

Repository files navigation

Quick Setup

wget https://raw.githubusercontent.com/anantshri/present/master/present -O $HOME/bin/present
chmod 755 ~/bin/present
~/bin/present init

For MacOSX folks if they don't have wget try following

curl "https://raw.githubusercontent.com/anantshri/present/master/present" -o $HOME/bin/present
chmod 755 ~/bin/present
~/bin/present init

Automated Reveal.js

reveal.js + external markdown mixed with some bash awesomeness to automated routine presentation tasks

Requirements

  1. a copy of reveal.js git repository from https://github.com/hakimel/reveal.js/ (Location to be marked as BASE) (it is assumed that $BASE/reveal.js will contain git clone of reveal.js)
  2. Chrome / Chromium browser as its --app feature is extensively used.
  3. a centeral directory to keep reusable resources such as images marked in RESOURCES (optional to keep images there)
  4. a index.html to be placed as template in $BASE which will contain a #markdownfilename# which will be replaced with acutal markdown filename at setup time.
  5. python 2.7 is what is used to test this. if you are using python 3 then you need to modify python simplehttpserver command (2 places in whole script)

Setup

wget https://raw.githubusercontent.com/anantshri/present/master/present -O $HOME/bin/present
chmod 755 ~/bin/present
~/bin/present init

For MacOSX folks or people who don't have wget try following

curl "https://raw.githubusercontent.com/anantshri/present/master/present" -o $HOME/bin/present
chmod 755 ~/bin/present
~/bin/present init

Usage

  1. perform steps from SETUP section

  2. create a directory at any location on system

  3. create your markdown file. (slides are horizontally seperated by --- and vertical seperation is by -- )

  4. Once markdown file is created run following command

  5. present setup markdown.md (if presentation.md then this command is not needed) This step will do all the necesaary linking and place a index.html

  6. present This step will launch browser with proper parameters which you can just maximize. The usual slide notes and stuff all works by default as per the template.

  7. present print This step will launch browser with proper parameters to provide printing. All you need to do is ctrl + P and save as PDF.

  8. present require This step will take a list of required markdown resources and will create a single presentation out of all those listed entries.

  9. present clean This step will clean all the stuff that present setup performed.

Disclaimer

I have taken care as to not harm the computer by this code but if something happens i am not to be held responsible.

About

revealjs workflow automation: reveal.js + external markdown mixed with some bash awesomeness to automate routine presentation tasks

Resources

License

Stars

Watchers

Forks

Packages

No packages published