This guide is for people writing or editing course material — the markdown content that themes, courses, and sections are built from — rather than people deploying or administering a Gutenberg instance. If that’s you, see the User Guide instead.
Course material lives in its own git repository, separate from the Gutenberg application. For Oxford’s default deployment that’s UNIVERSE-HPC/course-material; a Gutenberg instance can pull in one or more material repos, configured via YAML_TEMPLATE (see Configuration).
Pages
- Structure and Metadata — folder layout for themes, courses, and sections, and every frontmatter field each level supports.
- Course Tracks — the shapes a course’s
files:list can take, including grouping content into named tracks. - Directives and Links — challenge, solution, and callout syntax, and how internal links get resolved.
- Dependencies and Navigation — how
dependsOnworks and what it drives. - Checks and Linting — every automated check material goes through, and how to run each one locally.
- Creating a Course, Step by Step — a worked walkthrough that ties the above together.
If you just want to see your change rendered, follow the Docker development guide to run Gutenberg locally against your material branch.