GitHub, Markdown, and MkDocs

Overview

Teaching: 10 min
Exercises: 0 min
Questions

  • How are pages published?

Objectives

  • Explain how GitHub Pages produce web sites from Git repositories.

  • Explain MkDocs formatting rules.

Key Points

  • Lessons are stored in Git repositories on GitHub.

  • Lessons are written in Markdown.

  • MkDocs translates the files in the gh-pages branch into HTML for viewing.

  • The site's configuration is stored in mkdocs.yml.

  • Each page's configuration is stored at the top of that page.