Git Product home page Git Product logo

reveal-md's Introduction

reveal-md

Markdown server for reveal.js.

Installation

npm install -g reveal-md

Quick demo

reveal-md demo

Usage

To open specific Markdown file as Reveal.js slideshow:

reveal-md slides.md

Show (recursive) directory listing of Markdown files:

reveal-md dir/

Show directory listing of Markdown files in current directory:

reveal-md

Override theme (default: default):

reveal-md slides.md --theme solarized

Override slide separator (default: \n---\n):

reveal-md slides.md --separator "^\n\n\n"

Override port (default: 1948):

reveal-md slides.md --port 8888

Slide separators

  • To separate slides in Markdown, use three dashes (---, a ruler in Markdown), surrounded by empty lines. Or override as shown above.
  • Reveal.js supports "vertical" slides as well. Use ---- by default (also surround by newlines). This can also be overridden using --vertical from CLI.

Notes

  • reveal-md always starts a local server and opens the default browser
  • From any presentation, navigate to the root (e.g. http://localhost:1948/) to get directory listing of (linked) Markdown files. Root folder is resolved from Markdown file (or directory) reveal-md was started with.

reveal-md's People

Contributors

webpro avatar

Watchers

Nolboo Kim avatar James Cloos 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.