reveal-md for Mac

reveal.js on steroids! Get beautiful reveal.js presentations from Markdown files. [!WARNING] reveal-md is no longer in active development.

No new features will be added. Pull requests for bug and documentation fixes will be considered. Occasional dependency upgrades and CVEs might happen.

Thanks for using reveal-md! Please consider these Markdown-based alternatives: MkSlides (successor to reveal-md) Slidev

Installation

Usage

This starts a local server and opens any Markdown file as a reveal.js presentation in the default browser.

Docker

You can use Docker to run this tool without needing Node.js installed on your machine. Run the public Docker image, providing your markdown slides as a volume. A few examples:

The service is now running at http://localhost:1948.

To enable live reload in the container, port 35729 should be mapped as well:

Features Installation Usage Docker Features Markdown Code Section Theme Highlight Theme Custom Slide Separators Custom Slide Attributes reveal-md Options Reveal.js Options Speaker Notes YAML Front matter Live Reload Custom Scripts Custom CSS Custom Favicon Pre-process Markdown Print to PDF

• Using Puppeteer
• Using Docker & DeckTape

Static Website Disable Auto-open Browser Directory Listing Custom Port Custom Template Scripts, Preprocessors and Plugins Related Projects & Alternatives Thank You License

Markdown

The Markdown feature of reveal.js is awesome, and has an easy (and configurable) syntax to separate slides. Use three dashes surrounded by two blank lines (n---n). Example:

Code section

Syntax highlighting

js console.log('Hello world!');

Highlight some lines

You can highlight one line, multiple lines or both.

python [1|3-6] n = 0 while n { return new Promise((resolve, reject) => { return resolve( markdown .split('n') .map((line, index) => { if (!/^#/.test(line) || index === 0) return line; const is_vertical = /#^/.test(line); return (is_vertical ? 'n----nn' : 'n---nn') + line.replace('#^', '#'); }) .join('n') );