Generate web slides from Markdoc
graham.systems
1# morkdeck
2
3morkdeck is a dead-simple slideshow generator for
4[Markdoc](https://markdoc.dev/) files. Its guiding objectives are:
5
6- Minimizing time-to-presentation so you get your frickin' slides done
7- Opinionated styling and layout with easy outs, so you can focus on your
8 content
9- Your Markdoc is the source of truth; no codebase (node_modules, src directory,
10 etc.) required
11
12The name is a portmanteau of [MÖRK BORG](https://morkborg.com/),
13[Markdoc](https://markdoc.dev/), and
14[mdx-deck](https://github.com/jxnblk/mdx-deck) (my beloved).
15
16## Supported features
17
18- Single-file HTML output
19- Dev-server with live reload while you're editing your slides
20- Pretty code blocks using [Shiki](https://shiki.style)
21- [Mermaid diagram](https://mermaid.js.org/intro/) support with `mermaid` code
22 fences
23
24## Usage
25
26Still a work in progress, so we're failing objective #3.
27
28If you want to give morkdeck a try, you can clone this repo and use the
29`deno task` commands.
30
31```sh
32# Start a dev server at port 8000
33deno task dev my-slides.mdoc
34
35# Output a .html file in `./dist`
36deno task build my-slides.mdoc
37```