Skip to content
This repository has been archived by the owner on Feb 18, 2023. It is now read-only.

A plugin for Inkdrop, showing reveal.js presentation

License

Notifications You must be signed in to change notification settings

skipadu/reveal-md-presenter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

92 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

reveal-md-presenter

No longer updated and therefore archieved.

reveal-md-presenter is a plugin for Inkdrop

  • You can create and show your presentation straight from the Inkdrop!
  • It uses reveal-md to show the presentation.

Install

ipm install reveal-md-presenter

Next steps

1.) Install reveal-md

You need to install reveal-md to your system

Install reveal-md globally (You should install version before v4 as it currently has broken speaker notes).

npm install -g reveal-md@3.5.0

1b.) Manual start of reveal-md

If you are using Windows, you need to start reveal-md manually. Or if you are using macOS and want to start it manually for some reason.

  1. First enable manual start from the plugin's config.

  2. Then you will need to start the reveal-md with the generated start command. You can get it copied to your clipboard by selecting the "Copy start command" from the plugins menu or by pressing the shortcut Ctrl+OptC.

  3. Paste the start command to your terminal and start it.

2.) Start making the presentation

Now you are ready to write your presentation in the Inkdrop.

Quick quide

Write your presentation with Inkdrop and using Markdown.

To make horizontal slide change

 ---

It is Space and three dashes ---

To make vertical slide change

----

It is four dashes ----

Speaker notes

You can add notes that are shown in speaker notes window, opened with the S.

You can look this example presentation.

Keys in the Presenter Mode

When the Presenter Mode is activated and the window is opened. Everytime you open the Presenter Mode, the presentation will be saved to temporal file. If the Presenter Mode is already open, it just saves and reveal-md's watch options should make sure that the updated presentation is reloaded.

Here are the keys that reveal.js uses (These can not be configured from the plugin).

  • F = Fullscreen
  • ESC or O = Overview
  • S = Speaker View
  • B = Take a break

Screenshots

Horizontal slide

Vertical slide

Speaker notes

Licensing

MIT LICENSE