Courses

Write courses in Markdown and publish them as HTML slides.

• Requirements
• Getting started
• What sorcery is this?
• Usage
  • File structure
  • Scripts

Requirements

• Node.js 10+

Getting started

Install our Yeoman generator to get started:

npm install -g yo generator-courses-md

Create a directory in which to write your courses. Go into it and run the generator:

mkdir courses
cd courses
yo courses-md

Run yo courses-md --help or read the project's documentation to see what options are available.

What sorcery is this?

Courses MD allows you to write Markdown which will be automatically transformed into HTML slides.

The resulting HTML files are Remark slides and Courses MD uses md2remark to process the Markdown, so you should familiarize yourself with these 2 tools to know what you can do.