Skip to content

yusukebe/App-revealup

Repository files navigation

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 yusuke@kamawada.com

About

HTTP Server app for viewing Markdown formatted text as slides

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 5

pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy