A proof-of-concept eLearning solution which utilizes markdown files and parses them into lecture slides with interactive quizzes.
- Convert a file written in standard
Markdown
into a set lecture or presentation slides - Embed quiz questions with explanations and references using a simple syntax within markdown
- Markdown parsing using
Showdown.js
- Support for mathematical notation with
MathJax
.md
in-browser front-matter parsing usingjs-yaml-front-matter
- Base cross-browser compatible CSS from
HTML5 Boilerplate
-
Create a file in the form
PRESENTATION_NAME.memd
and place it in the/memd
directory wherePRESENTATION_NAME
is the name for your given lecture or presentation -
Add
title
,author
,date
,math
setting and optionalbackground
values as front-matter for meta regarding your presentation
---
title: "Example Presentation"
author: "Nafeu Nasir"
date: 2017-1-1
math: off
background: "white"
---
- Beneath your front-matter, create new slides simply by separating your markdown with
+++
like so:
# Intro
Here is your first slide
+++
Here is your second slide
+++
Standard markdown supported.
- Including the custom directive
<intro></intro>
in its own slide will generate an intro slide using the presentationstitle
andauthor
<intro></intro>
+++
git clone https://github.com/nafeu/minimal-elearning.git
cd minimal-elearning
bower install
...
Run your choice of development server out of the root directory.
ie. php -S localhost:8000
or python -m SimpleHTTPServer 8000