/m2v

A CLI that converts a markdown document to VERSAL course JSON

Primary LanguageCoffeeScript

m2v

A CLI that converts a markdown document to Versal course JSON

The rules

  • YAML front-matter is used to indicate the course title

  • H1's delimit lessons. The lesson will be titled after the H1 and everything under it will be converted to section headers and markdown gadgets.

  • H2's delimit sections. The section header will be titled after the H2 and everything under it will be converted to markdown gadgets.

  • Code blocks are rendered as Highlightr gadgets

Example

A simple course in markdown format might look like this

---
title: a course about things
---

# First lesson

First lesson content goes here

## First section

Some info in the first section

## Second section

Some more info in another section

# Second lesson

The second lesson needs some content too

See ./example.md for a more complex course

Usage

m2v ./example.md

Screenshot

This is what the course generated from ./example.md looks like

Screenshot

TODO

Obviously we need to render arbitrary gadgets