Skip to content

Latest commit

 

History

History
21 lines (18 loc) · 1.17 KB

README.md

File metadata and controls

21 lines (18 loc) · 1.17 KB

Workshop HTML generator

This repo contains code and a template used to generate HTML versions of workshops from the CIDR workshops repository. A GitHub Actions workflow on that repo uses the code here to generate/update the published versions when a push is made.

Features

  • Automatically generates a Table of Contents in an off-canvas sidebar.
  • To generate "callout" style boxes for activities or instructions, use:
!!! instruction "<optional title>"
    Your text here
  • Now with Dark Mode 🤪

Possible Enhancements

  • add visible "last updated" value
  • encode all images as base64?
  • Use <details/> to allow "spoiler"-style activity "answers".
  • Consider adding SASS/SCSS support to allow making the CSS source neater.
  • Think about local assets that use relative URLs -- right now the advice is to use absolute URLs. This is probably appropriate anyway, so that the .md files can stand alone as resources, but there might be some pain points here in the future.
  • Your suggestion here? Let me know!