No description
Find a file
2015-05-22 11:47:15 +00:00
.idea IDEA workspace commits 2015-01-26 15:47:43 -06:00
.gitignore Add README and minor tweaks 2015-01-29 15:59:06 -06:00
parser_conf.yaml Add fragment support and add programmatic js addition 2015-02-03 20:54:23 -06:00
presentation.yaml Fix the testcase and add a template 2015-05-22 11:47:15 +00:00
README.md Added Gitter badge 2015-02-17 22:58:24 +00:00
requirements.txt Add requirements 2015-01-26 17:31:26 -06:00
reveal_notes Add fragment support and add programmatic js addition 2015-02-03 20:54:23 -06:00
template.yaml Fix the testcase and add a template 2015-05-22 11:47:15 +00:00
todo Updated todo 2015-02-11 11:08:26 -06:00
yaml_reveal.iml IDEA workspace commits 2015-01-26 15:47:43 -06:00
yaml_reveal.py Update to use presentations from pres/ folder 2015-05-22 11:40:30 +00:00

Usage

Join the chat at https://gitter.im/ashneo76/yaml_reveal

  • Tested with python 3
  • The command line is helpful to provide information about all the accepted parameters
  • ./yaml_reveal.py -o <outputfile.htm> <inputfile>

Metadata configuration

Required section

metadata:
  author:
    name: "Ashish Shah"
    email: "ashneo76@gmail.com"
  presentation:
    title: "Presentation Title"
    description: "Presentation Decsripton"

Example with filled in defaults

metadata:
  author:
    name: "Ashish Shah"
    email: "ashneo76@gmail.com"
    social:
      - link: "http://"
        name: Website
      - link: "http://twitter.com/"
        name: "@twitterHandle"
  presentation:
    title: "Presentation Title"
    description: "Presentation Decsripton"
  theme:
    general: 'night'
    code: 'zenburn'
  printable: true
  mobile: true
  reveal:
    transition: convex

Reveal.js configuration

Parameter Value Options
controls true Default Value: true
progress true Default Value: true
slideNumber false
history false Default Value: true
keyboard true
overview true
center true Default Value: true
touch true Default Value: true
loop false
rtl false
fragments true
embedded false
help true
autoSlide 0
autoSlideStoppable true
mouseWheel false
hideAddressBar true
previewLinks false
transition 'default' none fade slide convex concave zoom
transitionSpeed 'default' default fast slow
backgroundTransition 'default' none fade slide convex concave zoom Default Value: 'convex'
viewDistance 3
parallaxBackgroundImage '' 'https://s3.amazonaws.com/hakim-static/reveal-js/reveal-parallax-1.jpg'
parallaxBackgroundSize CSS syntax "2100px 900px

Slides Section

** Please refer to the sample presentation.yaml included. **