You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
66 lines
2.5 KiB
66 lines
2.5 KiB
# ation
|
|
– a simple keynote software for markdown files – written using `electron`
|
|
|
|
|
|
|
|
## Usage
|
|
After opening any markdown file you can press <kbd>Tab</kbd> to show all
|
|
available keybindings. The keybindings are chosen, so they work with commont
|
|
presenters like the *"Logitech R400"*.
|
|
|
|
### Markdown
|
|
`ation` tries to make a presentation out of any ordinary markdown file. It
|
|
considers `H1` titles to be a standalone slide and `H2` titles to start a new
|
|
slide. There also is a special template for a "cover slide", which is
|
|
provisioned by meta data at the top of your markdown file.
|
|
|
|
### Meta data
|
|
To keep compatibility with other markdown parsers, `ation` does not implement a
|
|
`YAML` front matter or similar, but tries to parse the first `HTML` comment in
|
|
your markdown file as meta data. The meta data is specified as simple key-value
|
|
pairs, one pair per line, a color (`:`) seperating the key from the value.
|
|
|
|
**Possible values**
|
|
|
|
| Key | Type | Example Value |
|
|
| ---------------- | ------------------- | ---------------------------- |
|
|
| title | string | My Keynote |
|
|
| subtitle | string | an introduction into `ation` |
|
|
| author | string | MikO, Massive Dynamic |
|
|
| email | email address | miko@mail.tld |
|
|
| icon | path *(relative)* | ./my_logo.svg |
|
|
| color_highlight | CSS color value | #4994DA |
|
|
| color_background | CSS color value | #1A1A1A |
|
|
| color_text | CSS color value | #DDDDDD |
|
|
| font | CSS font identifier | Iosevka |
|
|
|
|
**Example**
|
|
```html
|
|
<!--
|
|
title : My Keynote
|
|
subtitle : an introduction into `ation`
|
|
author : MikO, Massive Dynamic
|
|
email : miko@mail.tld
|
|
icon : ./my_logo.svg
|
|
color_highlight : #4994DA
|
|
color_background : #1A1A1A
|
|
color_text : #DDDDDD
|
|
font : Iosevka
|
|
-->
|
|
```
|
|
|
|
The color values override the ones that have been set in `ation`'s settings on a
|
|
per slideshow basis.
|
|
|
|
## Installation
|
|
Either choose a pre-built release from the [releases page][release] or build
|
|
`ation` yourself running
|
|
|
|
```bash
|
|
npm i
|
|
npm run dist
|
|
```
|
|
|
|
Releases are currently only available for `macOS` and `Windows`.
|
|
|
|
[release]: releases |