marp-cue 0.1.1 → 0.2.0

package/README.md

@@ -1,6 +1,8 @@
-# Recording decks using Markdown
+# Autocue speaker notes using Markdown
 
-So I seem to have written a markdown-teleprompter-slideshow thing that works insanely well. No autoscroll, this is for 'speaker notes' type scripts rather than verbatim autocue. Gojko Adzic has a [lovely browser tool](https://gojko.net/tools/teleprompter/) for that.
+So I seem to have written a markdown-teleprompter-slideshow thing to scratch a personal itch.
+
+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.
 
 - H2 headings (`##`) separate slides
 - Active bullet highlighted, the rest dim
@@ -17,8 +19,6 @@ Put the following frontmatter in your Markdown file:
 ```yaml
 ---
 marp: true
-headingDivider: 2
-class: invert
 ---
 ```
 
@@ -28,6 +28,8 @@ Then run `marp-cue` from the directory like so:
 % npx marp-cue your-notes.md # or npx marp-cue .
 ```
 
-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.
+This will open a stripped-down browser window ('preview mode') for your file, or for every Markdown file in the directory that has `marp: true`. You can place this window in your teleprompter screen and the current line will stay vertically aligned in the middle of the viewport.
+
+Marp watches the file(s), so as soon as you save any changes, they show instantly without a refresh.
 
-Edits are instant, so if you switch from your Markdown editor to the browser window, updates show without a reload.
+You can just generate the HTML file to run elsewhere by passing `--preview false`, which disables preview mode.

package/marp.config.js

@@ -2,6 +2,7 @@ import teleprompterPlugin from './themes/teleprompter.js';
 
 const config = {
   engine: teleprompterPlugin,
+  options: { headingDivider: 2 },
   preview: true, // start preview window(s)
   theme: 'teleprompter',
   themeSet: 'themes'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "marp-cue",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Teleprompter-style scrolling for Marp presentations",
   "author": "Daniel Terhorst-North <daniel@dannorth.net>",
   "license": "MIT",
@@ -13,11 +13,11 @@
   ],
   "repository": {
     "type": "git",
-    "url": "https://gitlab.com/tastapod/marp-cue.git"
+    "url": "git+https://gitlab.com/tastapod/marp-cue.git"
   },
   "type": "module",
   "bin": {
-    "marp-cue": "./cli.js"
+    "marp-cue": "cli.js"
   },
   "files": [
     "cli.js",

package/themes/teleprompter.css

@@ -2,6 +2,11 @@
 
 @import 'uncover';
 
+section {
+    background: #202228;
+    color: #fff;
+}
+
 /* Dim inactive lines */
 li[data-bespoke-marp-fragment] {
 
@@ -13,15 +18,17 @@ li[data-bespoke-marp-fragment] {
         color: white;
     }
 
+    /* Make sub-bullets look different */
     li[data-bespoke-marp-fragment] {
         font-size: smaller;
+
         &[data-bespoke-marp-current-fragment] {
             color: cyan;
         }
     }
 }
 
-/* Add enough vertical space around the slide to centre the current line */
+/* Add enough vertical space around the slide to always centre the current line */
 section:has([data-bespoke-marp-fragment]) {
     padding-block: 80vh;
 }