https://github.com/coopdevs/speakit
Markdown slides generator. Write markdown, compile to HTML and PDF
https://github.com/coopdevs/speakit
Last synced: 8 days ago
JSON representation
Markdown slides generator. Write markdown, compile to HTML and PDF
- Host: GitHub
- URL: https://github.com/coopdevs/speakit
- Owner: coopdevs
- Created: 2018-03-08T14:41:09.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-03-18T20:46:32.000Z (over 8 years ago)
- Last Synced: 2025-02-22T11:18:12.853Z (over 1 year ago)
- Language: Shell
- Size: 8.79 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Speakit :speaker:
A command line tool to enforce a set of conventions writting slides in markdown. This plain text format makes it easy to share and replicate content by means of copy-paste and also makes it possible to export to PDF for presentation purposes.
By making these conventions executable and applying a predefined style you only need to focus on the content you want to share with the audience. Preparing presentations is hard enough, let machines do the rest.
This project is heavily inspired on [Deckset](https://www.decksetapp.com).
## Installation
Speakit requires:
* Bash >= 4
Speakit uses [Marp](https://yhatt.github.io/marp/) to export the slides to PDF, which also provides a preview. Follow [its installation instructions](https://github.com/yhatt/marp#install.)
Now you can install `speakit` running the following command:
```shell
$ wget https://raw.githubusercontent.com/coopdevs/speakit/master/install.sh | sh
```
## Usage
### Setup
To create a presentation run:
```shell
$ speakit "my presentation"
```
This will generate the following directory structure:
```
my_presentation
├── README.md
├── images/
├── notes.md
└── slides.md
```
Now you can start working on your slides in `slides.md`.
### Export to PDF
To export the slides to PDF open your `slides.md` in Marp and click on File > Export
Slides as PDF...