Code Monkey home page Code Monkey logo

app-revealup's Introduction

Build Status

NAME

App::revealup - HTTP Server application for viewing Markdown formatted text as slides

SYNOPSIS

$ revealup serve slide.md --port 5000

DESCRIPTION

App::revealup is a web application module for giving Markdown-driven presentations. The revealup command starts a local web server to serve the your markdown presentation file with reveal.js. The presentation can be viewed in a web browser. The reveal.js library offers comprehensive presenting features such as slide transitions, speaker notes and more.

Sample Markdown

## This is an H2 Title

Description... The horizontal slide separator characters are '---'

---

## This is second title

The vertical slide separator characters are '___'

___

## This is a third title

---

## This is a forth title
<!-- .slide: data-background="#f70000" data-transition="page" -->

You can add slide attributes like above.

Note:
This is a speaker note. It can be viewed in the speaker mode, just press S during the presentation to view notes and other useful information.

COMMANDS

  • serve

      $ revealup serve markdown.md --theme night.css
    

    serve command launch the HTTP server for showing slides on your web browser.

    SEE MORE: App::revealup::cli::serve

  • export

      $ revealup export theme --base beige.css --output style.css
    

    export command generate the files such as CSS of the theme and HTML for the slides.

    SEE MORE: App::revealup::cli::export

LICENSE

Copyright (C) Yusuke Wada.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

reveal.js

reveal.js is by Hakim El Hattab, http://hakim.se.

https://github.com/hakimel/reveal.js/

AUTHOR

Yusuke Wada [email protected]

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.