Skip to content

Latest commit

 

History

History
38 lines (22 loc) · 1.03 KB

CONTRIBUTING.md

File metadata and controls

38 lines (22 loc) · 1.03 KB

Contributions

Feel free to contribute to this course by submitting pull requests or opening issues.

Development Guide

We use npm to manage our dependencies.

npm install

Develop the presentation

Embed code snippets into the content files with EmbedMe, then render the page with Vite. Source code changes are automatically reflected in the browser.

npm run embed
npm run dev

Build the presentation

Bundle the final presentation into a single deployment. Optionally check that all snippets have been embedded.

npm run embed-verify
npm run build

Build the excerpt

If you have Pandoc installed, you can directly use the script from within the slides directory.

cd slides
./excerpt.sh

Alternatively, you can utilize a small Docker container to build the excerpt.

docker run --rm -v "$(pwd)/slides:/data" --entrypoint "./excerpt.sh" pandoc/core:2.19.2

Find the final excerpt at ./slides/dist/excerpt.html.