Git Product home page Git Product logo

node-reveal's Introduction

@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

node-reveal's People

Contributors

dependabot[bot] avatar renovate-bot avatar vivaxy avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

node-reveal's Issues

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Error type: undefined. Note: this is a nested preset so please contact the preset author if you are unable to fix it yourself.

Use template-literal instead of EJS

Template Literal is fastest, smallest and simplest template engine, because it use JS's literal template feature.

It's 55 times faster than EJS, and it also use less CPU and RAM ressources, so it may be a good idea to use it instead of EJS ๐Ÿ˜€

New version with reveal 4

Hi!

You are doing awesome work! You project makes working with revealjs so much more fun.

Can you already say when you will publish a new version on npm that includes revealjs 4? I saw you already reference v4 on GitHub. Does that mean that new release on npm is not that far away?

Greetings,
Rainer.

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.