course.yaml
schema_version: 1 # 必填,框架据此判断能否读取
id: my-course # 不可变,也是 URL 段
title: { zh: 我的课程, en: My Course }
description: 一句话简介
default_language: zh
languages: [zh, en]
license:
type: CC-BY-4.0
commercial_use: true
authors:
- name: 你的名字
chapters: [intro, advanced] # 或使用 sections 分组,二选一
导入自其他仓库的课程还需要 source.repository 与 source.commit,用于追溯内容来源。
chapter.yaml 与 lesson.yaml
# chapter.yaml
id: intro
title: 入门
lessons: [first-steps, setup]
# lesson.yaml
id: first-steps
title: 第一步
code: { label: examples/first-steps, url: https://example.com/repo/tree/abc123/examples }
video、quiz、lab 字段目前只做预留。
可以直接下载最小模板:example-course.yaml。