Git Product home page Git Product logo

revelator's Introduction

the Revelator

Who's That Writin' Reveal.js Slide HTML?

Not me.

Relevator generates Reveal JS presentation decks from simplified (and easier to edit) YAML files.

This is NOT actively maintained anymore, and the error handling around the YAML isn't very good. There probably should be a Python "DSL" instead to make it easier.

Background

Reveal.js is a pretty awesome framework for generating web-based slides.

This is what Reveal.js looks like: http://lab.hakim.se/reveal-js/#/

HTML you write typically looks like: https://github.com/hakimel/reveal.js/blob/master/index.html

Except with Revelator, you can write simpler things like: https://github.com/mpdehaan/slide-the-revelator/blob/master/test.yml

So you have to write a lot less of the angle brackets.

Usage

chmod +x write_it
vim test.yml
write_it test.yml my_presentation_directory
sensible-browser my_presentation_directory

Supported Reveal.js Features

  • Setting the Title, Author, and Description
  • HTML tags via shorthand
  • Class notes
  • Nested slides
  • Changing background colors
  • Changing transitions
  • Images
  • Hyperlinks
  • Formatted Code Blocks
  • Ordered and Unordered Lists
  • Blockquotes

Syntax

Here's how slide transitions and fragments (transitions between parts of slides) work:

set_global options:

  • fragment
    • true
    • false
    • grow
    • shrink
    • "roll-in"
    • "zoom-in"
    • "highlight-blue|green|red"
    • "highlight-current-blue|green|red"
    • "fade-out" +/- "-visible"
  • transition
    • linear
    • concave
    • zoom
    • cube
    • page
    • fade

License

GPLv3

Author

Michael DeHaan

revelator's People

Contributors

mpdehaan avatar arrfab avatar jimi-c avatar mbbroberg avatar tgerla avatar

Watchers

James Cloos avatar joejiafeng avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.