https://github.com/yusukebe/app-revealup

HTTP Server app for viewing Markdown formatted text as slides
https://github.com/yusukebe/app-revealup

cpan-module markdown perl perl5 revealjs slide

Last synced: 9 days ago
JSON representation

HTTP Server app for viewing Markdown formatted text as slides

• Host: GitHub
• URL: https://github.com/yusukebe/app-revealup
• Owner: yusukebe
• License: other
• Created: 2014-05-25T01:03:51.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2022-06-29T00:30:40.000Z (over 2 years ago)
• Last Synced: 2025-01-04T01:00:18.053Z (18 days ago)
• Topics: cpan-module, markdown, perl, perl5, revealjs, slide
• Language: Perl
• Homepage: https://metacpan.org/pod/App::revealup
• Size: 141 KB
• Stars: 38
• Watchers: 4
• Forks: 12
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: Changes
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/yusukebe/App-revealup.svg?branch=master)](https://travis-ci.org/yusukebe/App-revealup)

# 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

    

    

    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](https://metacpan.org/pod/App%3A%3Arevealup%3A%3Acli%3A%3Aserve)

- `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](https://metacpan.org/pod/App%3A%3Arevealup%3A%3Acli%3A%3Aexport)

# 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](http://hakim.se).

[https://github.com/hakimel/reveal.js/](https://github.com/hakimel/reveal.js/)

# AUTHOR

Yusuke Wada