presentomatic/README.md

Simple presentations using markdown

# Presentomatic

Quickly turn Markdown documents into presentations.

## Quickstart

### I just want to present a markdown file

Run `npx presentomatic serve` in a directory with a `PRESENTATION.md` file.

### I want to create a PDF out of that `PRESENTATION.md` file

Run `npx presentomatic pdf` in a directory with a `PRESENTATION.md` file.

## Global installation

`npm i -g presentomatic`

## Help

`presentomatic --help`

## Markdown formatting

Separate slides with `---`

## Nice features

### Mermaid diagrams

Supports mermaid diagrams:

```
<pre class="mermaid">
flowchart TD
    A[Christmas] -->|Get money| B(Go shopping)
    B --> C{Let me think}
    C -->|One| D[Laptop]
    C -->|Two| E[iPhone]
    C -->|Three| F[fa:fa-car Car]
</pre>
```

### Build and Serve directly to GitHub pages

Add this file to your GitHub repository: 

https://github.com/tran-engineering/presentomatic/blob/main/.github/workflows/static.yml

It will build and serve the static presentation.