Skip to content
This repository was archived by the owner on May 24, 2024. It is now read-only.

vivaxy/node-reveal

Folders and files

NameName
Last commit message
Last commit date

Latest commit

abd6fb7 Β· May 24, 2024
May 24, 2024
Feb 9, 2021
Nov 15, 2019
Jun 4, 2017
Nov 15, 2019
Jul 30, 2020
Jul 30, 2020
Jul 30, 2020
Oct 9, 2018
Oct 9, 2018
Jun 1, 2017
Oct 9, 2018
Oct 9, 2018
Oct 9, 2018
Jul 30, 2020
May 31, 2017
Feb 9, 2021
Feb 9, 2021
May 9, 2020
Feb 8, 2021

Repository files navigation

@vivaxy/reveal

@vivaxy/reveal

🎁 A reveal.js cli

NPM Version NPM Downloads MIT License Standard Version

screenshot-1

Feature

Based on reveal.js.

  • Easy to setup. No cloning repositories. No template files.
  • Markdown files as slides content.
  • Sync sliding between clients.
  • Auto reload when markdown file changes.
  • Speaker view.
  • Theme config.
  • Inline html.

Notable Markdown Syntax

  • Use \r?\n----\r?\n as horizontal slides separator.
  • Use \r?\n---\r?\n as vertical slides separator.
  • Use ^Note: as speaker notes separator.
  • Use <!-- .slide: data-background="#ff0000" --> to customize slide styles.
  • Use <!-- .element: style="width: 60%;" --> to customize element styles.
  • Use <!-- .element: class="fragment" --> to create fragment.

Basic Usage

npx

npx @vivaxy/reveal server --markdown /path/to/presentation.md

Keyboard Shortcuts

  • Space: Next
  • Up, Down, Left, Right: Navigation
  • k, j, h, l: Navigation
  • f: Full-screen
  • s: Show slide notes
  • o: Toggle overview
  • . (Period, b, v or /): Turn screen black
  • Esc: Escape from full-screen, or toggle overview
  • alt + Left Click: Toggle zoom
  • p, n: Previous and next

Advanced Usage

Commands

server

Basic Usage
reveal server \
    --markdown ./ppt/reveal.md \
    --theme solarized \
    --highlight-theme solarized-light \
    --transition slide \
    --port 8080 \
    --watch \
    --separator '^\r?\n----\r?\n$' \
    --separator-vertical '^\r?\n---\r?\n$' \
    --separator-notes '^Note:' \
    --width 1440 \
    --height 900 \
    --log-level 2 \
    --script 'custom.js'
Options
Name Type Required Default Description
--markdown string βœ” N/A markdown file
--theme string βœ– solarized reveal.js theme
--highlight-theme string βœ– solarized-light highlight.js theme
--transition string βœ– slide reveal.js transitions styles
--port number βœ– 0 server port
--watch boolean βœ– false reload when markdown changed
--separator string βœ– ^\r?\n----\r?\n$ horizontal slides separator
--separator-vertical string βœ– ^\r?\n---\r?\n$ vertical slides separator
--separator-notes string βœ– ^Note: speaker notes separator
--width number βœ– 1440 slide width
--height number βœ– 900 slide height
--log-level number/string βœ– 2 log output level
--script string βœ– '' insert custom script before head

URL Parameters

print-pdf

Used to print as pdf files.

Add ?print-pdf&showNotes=true, like: http://127.0.0.1:3000/?print-pdf#/.

Press Ctrl/Command + p to open print dialog.

Usually, print-pdf is used with showNotes, like http://127.0.0.1:3000/?print-pdf&showNotes=separate-page#/

showNotes

Show speakers notes.

Add ?showNotes=true, like: http://127.0.0.1:3000/?showNotes=true#/.

Support

node >= v12

Change Log

See CHANGELOG.md.

Prior Art