| title | author | date |
|---|---|---|
reveal-md slides |
hasp |
20240929 |
Template / Introductory Repository to explain markdown slide creation with reveal-md.
Warning
- install node.js:
winget install OpenJS.NodeJS.LTS - install reveal-md:
npm install -g reveal-md - update/upgrade all global packages:
npm update -gnpm upgrade -g
- To show all documents of
lecturesandexercisefolder:- stay in root-folder of repository
- and start:
reveal-md . -w-wis optional and watches for file changes
- To show a specific document (using this readme as example):
reveal-md README.md
- For parameter overview just type
reveal-md - Slide creation: use Typora and vscode.
- See the various slides to get an idea whats possible
- global configuration:
reveal-md.json - can be overwritten by YAML frontmatter in
md-files - folder
.reveal:- css styling (
style.css) - mermaid plugin (
mermaid.min.js)
- css styling (
- Our slides tool: https://github.com/webpro/reveal-md
- Based on this HTML slide tool: https://revealjs.com/
- Code highlighting: https://highlightjs.org/demo
- Mermaid graphs: https://mermaid.js.org/
- especially the docs
- consider the mermaid live editor
- consider to update
mermaid.min.jsevery now and then- atm version 11.1.1 is used
- see/download mermaid.min.js from CDN
- Improvement of
README.md... 😜 - Add
reveal-md.jsonand.reveal-folder to other templates
Warning
(see this issue)
- Settings Error: settings not working in:
reveal-md.jsonand- YAML Frontmatter of
.md-files
- Display Error: the mermaid graph size is often not correctly show
Another problem (of reveal-md):
favicon.iconot working as intended
- Settings Error: add mermaid settings directly to diagram (as frontmatter)
- Display error: refresh the browser (
Ctrl+R) for redraw- this needs the setting
"history": trueinreveal-md.json - otherwise you start at slide one.
- use Typora and vscode!
- this needs the setting