How to create a new set of slides

1. Clone the repo

> git clone git@gitlab.com:sirenia/docs/slides.git

2. Create a new branch from master

> git checkout -b name-of-my-slideshow

3. Edit README.md with new content and add images etc, then commit and push

> git commit -m "Added content for my slideshow" && git push -u origin 

Location of slides

Slides are built and then published to http://slides.sirenia.io/name-of-my-slideshow

PDF versions are also available at http://slides.sirenia.io/name-of-my-slideshow/slides.pdf

(Replace name-of-my-slideshow with the name of your branch)

Update the template

Is done by merging any changes from master into your branch and pushing.

Rendering slides locally

For faster turn-around you may want to render the slides locally. First install:

> yarn global add sass @marpteam/marp-cli

Then do

> sass --watch themes:themes

and

> marp -w --theme themes/sirenia.css README.md

and open the generated README.html file in a browser.

Markdown

About the markdown supported etc can be found at https://marpit.marp.app/

Plugins

Emojis are supported 😎 👍

And neat typographical replacements like -- turning into – and curly “quotes” via https://github.com/sireniaeu/markdown-it-typographer

And abbreviations like RTFM can be defined through https://github.com/markdown-it/markdown-it-abbr

Abd tags which can then be styled, e.g. [*red*]{.red} becomes red with the proper style tag on the slide via https://github.com/arve0/markdown-it-attrs

Styles

The slides have a few built-in styles which you can apply to a complete deck with:

<!-- class: black -->

or for a single slide:

<!-- _class: black -->

The following slides showcase the available styles.