Giter Club home page Giter Club logo

revelar's Introduction

Revelar

Create stunning presentations in Markdown using Reveal.js from the confort of your command line.

Creating a new presentation

Start by installing the revelar utility globally:

npm install --g revelar

Create a new presentation project.

revelar create presentation-name

This will create a new folder called presentation-name with:

  • A slides folder to contain your slides divided into multiple sections;
  • A themes folder to contain custom themes (like a sample yellow.css);
  • And the revelar_config.json with configuration parameters.

Running the server

Once the project is created, start the server to see the slides:

revelar

And point your browser to http://0.0.0.0:8000/.

Anatomy of a slide

Inside the slides folder you can place as many Markdown files as you want.

Each file will correspond to a different section in your presentation.

Each section can contain multiple slides, each separated by a --.

Here is an example of a section writen in a Markdown file:

# Revelar
## This is awesome

[paulo.ragonha.me](http://paulo.ragonha.me)

[@pirelenito](http://twitter.com/pirelenito)

--
# A second slide

--
# And a third

Themes

It is possible to change the theme of your presentation from the available Reveal.js themes by specifying it in the revelar_config.json file:

{
  "theme": "sky"
}

Custom themes

You can place your custom theme files inside the themes folder and use them the same way as a default theme.

Acknowledgments

This is build on top of the amazing Reveal.js framework.

Author

Paulo Ragonha.

revelar's People

Contributors

pirelenito avatar

Watchers

James Cloos avatar Rodrigo Vieira 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.