maxg/handx


Markdown handouts + exercises

License: Other

Language: JavaScript


handx

Markdown handouts + exercises

example/handout

An example handout!

Clone this repository and open example/handout/index.html.

example/slides

Example slides!

Clone this repository and open example/slides/index.html.

web/handout

JavaScript and CSS for rendering and running handouts.

For local development, the handout HTML file includes handout-render.js to render the page in the browser. handout-render then loads handout-run.js to handle exercises and interactive elements. Exercise answers are checked locally.

For deployment, the handout HTML page is loaded in PhantomJS using deliver/deliver.phantom.js, pre-rendered, and the resulting HTML file only includes handout-run. Exercise answers are also stripped from the file and checked server-side.

scripts

Shell scripts for pre-rendering handouts.

deliver-handouts pre-renders a directory of handouts as described above. It delivers HTML files to one directory, for display on the web, and JSON files with exercise answers to another directory, for use by the server-side exercise checker.

repo-post-receive-hook is designed for use with Git Meta-Hooks and deliver-handouts-athena on Athena.

Project Statistics

Sourcerank 4
Repository Size 252 KB
Stars 1
Forks 1
Watchers 1
Open issues 15
Dependencies 0
Contributors 1
Tags 0
Created
Last updated
Last pushed

Top Contributors See all

Max Goldman

Something wrong with this page? Make a suggestion

Login to resync this repository