https://github.com/yerkopalma/mtalk
https://github.com/yerkopalma/mtalk
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/yerkopalma/mtalk
- Owner: YerkoPalma
- Created: 2018-04-04T01:10:09.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-05-12T17:58:39.000Z (about 7 years ago)
- Last Synced: 2025-01-25T07:11:20.907Z (5 months ago)
- Language: JavaScript
- Size: 170 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# mtalk
> Presentations made easy
## Usage
```bash
$ mtalk talks-folder
```
And that's all.
**Note**: For this to work you need Node v8.5+
### Slide structure
Slides are markdown files with metadata
```md
---
meta: data
---
# Slide title
Some content
```
Each slide could have the following metadata
- **title**: The title for the slide document.
- **next**: The name of the next slide file. Use a dot (.) for the last slide.
- **prev**: The name of the previous slide file. Use a dot (.) for the first slide.
- **speech**: An object with some options to enable speech for this slide. If
this is not set, your slide wont have any speech. Availaible options are:
- lang: The language of the speech.
- audio: What to speech. If not set, it will read everything on this slide.
## Features
- **:raising_hand: Easy**: No programming skills needed, just markdown.
- **:rocket: Slides are PWAs**: Slides use service workers, so they are
offline-first, also have a manifest, so they are installable.
- **:globe_with_meridians: p2p distributed**: Slides are automatically shared
through Dat.
- **:nail_care: a11y friendly**: Slides are responsive, also controls.
Optionally add _speech_ to your slides.
## Controls
- → or _Tap_: Use ArrowRight key to move forward.
- _ or _Tap_: Use Space key to move forward.
- ← or _Double tap_: Use ArrowLeft key to move backward.
- f8 or _Tap and hold_: Use f8 key to _read_ current slide.
## License
MIT