this repo has no description
docs(readme): update usage and list features
+16
-9
+16
-9
README.md
+16
-9
README.md
···
1
1
# morkdeck
2
2
3
3
morkdeck is a dead-simple slideshow generator for
4
-
[Markdoc](https://markdoc.dev/) files. Its guiding concepts are:
4
+
[Markdoc](https://markdoc.dev/) files. Its guiding objectives are:
5
5
6
-
- Minimizing time-to-presentation so you get your freaking slides done
6
+
- Minimizing time-to-presentation so you get your frickin' slides done
7
7
- Opinionated styling and layout with easy outs, so you can focus on your
8
8
content
9
9
- Your Markdoc is the source of truth; no codebase (node_modules, src directory,
···
13
13
[Markdoc](https://markdoc.dev/), and
14
14
[mdx-deck](https://github.com/jxnblk/mdx-deck) (my beloved).
15
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 fences
22
+
16
23
## Usage
17
24
18
-
Still a work in progress.
25
+
Still a work in progress, so we're failing objective #3.
19
26
20
-
If you really want to give it a try, you can clone the repo and point
21
-
`main.ts dev` at a Markdoc file of your choice:
27
+
If you want to give morkdeck a try, you can clone this repo and use the `deno task` commands.
22
28
23
29
```sh
24
-
deno run --unstable-broadcast-channel -A main.ts dev ./slides.mdoc
25
-
```
30
+
# Start a dev server at port 8000
31
+
deno task dev my-slides.mdoc
26
32
27
-
You'll be able to access your presentation at port 8000. Static builds aren't
28
-
implemented yet.
33
+
# Output a .html file in `./dist`
34
+
deno task build my-slides.mdoc
35
+
```