marp-cue 0.1.0 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +17 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,16 +1,16 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Autocue speaker notes using Markdown
|
|
2
2
|
|
|
3
|
-
So I seem to have written a markdown-teleprompter-slideshow thing
|
|
3
|
+
So I seem to have written a markdown-teleprompter-slideshow thing to scratch a personal itch.
|
|
4
|
+
|
|
5
|
+
This is for 'speaker notes' type scripts rather than verbatim scrolling autocue. Gojko Adzic has a [lovely browser tool](https://gojko.net/tools/teleprompter/) for that.
|
|
4
6
|
|
|
5
7
|
- H2 headings (`##`) separate slides
|
|
6
8
|
- Active bullet highlighted, the rest dim
|
|
7
|
-
- Sub-bullets highlighted a different colour
|
|
8
|
-
-
|
|
9
|
-
- Uses
|
|
9
|
+
- Sub-bullets highlighted a different colour
|
|
10
|
+
- *Keeps current bullet in centre of viewport* ('typewriter mode') so you aren't looking up and down the screen
|
|
11
|
+
- Uses [Marp](https://marp.app/), so arrow keys, home/end, clicker all do what you would expect
|
|
10
12
|
- Live update: edit the markdown, view hot-reloads
|
|
11
|
-
- Installable as Chrome or Safari 'app' to remove the browser cruft
|
|
12
13
|
- Theme-able, everything except scroll-centring is CSS
|
|
13
|
-
I am using [MARP](https://marp.app/) to render my Markdown notes as nicely formatted presentation notes with a highlighted bullets.
|
|
14
14
|
|
|
15
15
|
## Usage
|
|
16
16
|
|
|
@@ -23,3 +23,13 @@ headingDivider: 2
|
|
|
23
23
|
class: invert
|
|
24
24
|
---
|
|
25
25
|
```
|
|
26
|
+
|
|
27
|
+
Then run `marp-cue` from the directory like so:
|
|
28
|
+
|
|
29
|
+
```sh
|
|
30
|
+
% npx marp-cue your-notes.md # or npx marp-cue .
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
This will open a stripped-down browser window for your file, or for every Markdown file in the directory. You can place this window in your teleprompter screen and the current line will stay vertically aligned in the middle of the viewport.
|
|
34
|
+
|
|
35
|
+
Edits are instant, so if you switch from your Markdown editor to the browser window, updates show without a reload.
|