Skip to content

Latest commit

 

History

History
83 lines (68 loc) · 2.13 KB

index.md

File metadata and controls

83 lines (68 loc) · 2.13 KB

Genie

Genie is a place for you to publish open-source lessons. All of your lessons will be in simple text files that are easy to maintain and fully owned by you.

Getting Started

A simple lesson directory looks like the following:

  • index.md - a text file containing your lesson in markdown format
  • manifest.yml - a YAML file that describes your lesson

Refer to the manifest of this lesson for an example.

GitHub Flavored Markdown

Most of the markup can be written in the usual Markdown, with a few GitHub extensions. More information can be obtained from the GFM documentation, but here is a quick preview.

code output
~~strikethrough~~ strikethrough
no_intra_emphasis no_intra_emphasis
http://auto.link http://auto.link/

Foundation

This template is built using foundation, so all of the Foundation components will still work, if writing HTML if your kind of thing.

Code

Code is highlighted using Pygments, and it looks like

  puts "hello world!"

Problems

Problems may be described using embedded YAML. We currently support three question types: MCQs, Short Answers, and Tables. Embedded YAML blocks must be enclosed by three consecutive quotation " marks.

For example, the source for the following question is:

format: multi
question: How _tall_ is Mount Everest?
answer: B
options:
  A: 66 inches
  B: 8.85 kilometers
  C: 123400 feet

""" format: multi question: How tall is Mount Everest? answer: B options: A: 66 inches B: 8.85 kilometers C: 123400 feet """

""" format: short question: What is the most commonly used word in English? answer: the """

""" format: table question: Fill in the missing values in the following table. headings: [A, B, C] grid:

  • [0, '?', 2]
  • ['?', 4, 5] answer:
  • [0, 1, 0]
  • [3, 0, 0] """