/miniseminar

Confluence as a backend -> Express -> reveal.js as a presentation -> Profit!

Primary LanguageTypeScriptMIT LicenseMIT

miniseminar

dockeri.co

Build Status Greenkeeper badge Dependency Status CodeFactor

Confluence as a backend -> expressjs -> reveal.js as a presentation -> Profit!

Requirements

  • Confluence server(or cloud)

How to run

$ docker run -ti -p 3000:3000 \
      -e HOST=https://confluency.atlassian.net \
      -e CONTEXT=wiki \
      -e AUTHTYPE=no \
      heycalmdown/miniseminar
$ HOST=https://confluency.atlassian.net CONTEXT=wiki AUTHTYPE=no node ./www/bin

You can get a frontpage at the localhost:3000/. Or open your preferred browser and type localhost:3000/page/:your-confluence-page-id. The page id should be a number.

Config

You can override configs with environment variables.

Name Notes
HOST http(s)://your.host.name:port
CONTEXT You can set this with '' (empty string) when you don't have context trailing after the hostname.
USERNAME
PASSWORD
AUTHTYPE no | basic | cookie
PINNED_PAGES You can pin your notice pages. Comma-separated ids.
$ docker run -d -p 3000:3000 \
      -e HOST=http://your.host.name:port \
      -e CONTEXT=wiki \
      -e USERNAME=haha \
      -e PASSWORD=hoho \
      heycalmdown/miniseminar

Markup

Type Notes
Slide Add double horizontal rule from the Confluence editor. Or you can use four dashses(----) twice.
Vertical Slice Add single horizontal rule
Links Use any link style which Confluence support
Image Use any image style which Confluence support including attachments not only external one
Background Image Make the last image as a background if you reset an image size to original
Table Use Confluence table as usual
Fragments Ends a sentence with (unicode return symbol)
Code Highlight Use Confluence code block
Theming Use a query parameter ?theme=black or type t on a slide
Transition Style Use a query parameter ?transition=slide

Supporting Confluence Plugins

Shortcuts

Check this Keyboard Shortcuts out

  • N, SPACE: Next slide
  • P: Previous slide
  • , H: Navigate left
  • , L: Navigate right
  • , K: Navigate up
  • , J: Navigate down
  • Home: First slide
  • End: Last slide
  • B, .: Pause (Blackout)
  • F: Fullscreen
  • ESC, O: Slide overview / Escape from full-screen
  • S: Speaker notes view
  • ?: Show keyboard shortcuts
  • alt + click: Zoom in. Repeat to zoom back out.

And,

  • T: Change the theme