Course Syllabus Management

Overview

Course syllabuses can be managed in two ways:

1. Traditional Method: Directly in the course’s front matter using syllabusBefore and syllabus properties.
2. External File Method: In a separate syllabus.yaml file in the course directory.

The external file method is preferred for courses with extensive syllabus content as it keeps the front matter cleaner and easier to maintain.

External File Method

To use the external file method:

1. Create a syllabus.yaml file in the same directory as your course’s _index.md file.
2. Structure the file as follows:

 1syllabusBefore:
 2- title: "Preparation"
 3  link: "./preparation/"
 4  duration: 15
 5  type: page
 6  weight: 1
 7syllabus:
 8- id: 1
 9  title: "Module Title"
10  duration: 60
11  content: "Module description goes here."
12  learningResources:
13  - title: "Resource Title"
14    link: "https://example.com"
15    duration: 10
16    type: guide
17    weight: 1
18  assignment:
19    title: "Assignment Title"
20    content: "Assignment content goes here."
21    examples: "Assignment examples go here."

3. Remove the syllabusBefore and syllabus sections from your course’s front matter if they exist.

The system will automatically detect and use the external file if it exists. If no external file is found, it will fall back to using the front matter data.