The deck folder¶

Learn which files mkdeck reads, which files it copies into a build, and which files it writes.

talk/
  deck.md          the slides
  deck.yml         the deck settings
  assets/          figures, HTML pages, images, fonts
  theme/mine.css   your own stylesheet (optional)
  theme/marks.js   your own script (optional)

Files mkdeck reads¶

mkdeck reads two files from the deck folder:

You can pass either a folder or a .md file to a command. With a file, the deck folder is the folder that holds it.

Files mkdeck copies¶

A folder build copies four kinds of file into the output folder:

1. The whole assets/ folder, except hidden files and hidden folders.
2. Each file that a figure names, wherever it sits under the deck folder.
3. Each file that extra_css or extra_js names.
4. The front-end files, such as reveal.js, KaTeX, and the theme. They go into mkdeck-assets/.

mkdeck copies nothing else. For example, a data.js beside figs/g.html stays behind, because only that page refers to it. The same holds for a file that raw HTML names. To copy such a file, put it under assets/. An http or https URL needs no copy.

Files mkdeck writes¶

Each command writes to a default place:

mkdeck serve ignores changes to these three names inside the deck folder, so a build or a check does not trigger a reload.

Limits¶

Next: Slide basics.