Skip to content

File-based authoring

Author courses with course.yaml, Markdown lessons, HTML interactions, and YAML quizzes — no React required.

Who this is for: instructional designers, SMEs, teams using Claude or Cursor to edit course files, and anyone migrating from Storyline or Rise.

Outline

Step Guide
Requirements What you need
Install Install the CLI
First course Your first course
Folder layout Course structure
Markdown lessons Writing lessons
HTML labs Building interactions
Quizzes Quizzes and assessments
Branching Branching and paths
Preview Preview and review
LMS export Export to LMS
Example walkthrough Build overview
Terms Glossary

Core workflow

Validate course (run from course folder)
lxpack validate
Validate for xAPI/cmi5 export
lxpack validate --target xapi
Start local preview server
lxpack preview
Build SCORM 1.2 package (most LMS)
lxpack build --target scorm12
Build SCORM 2004 package
lxpack build --target scorm2004
Build xAPI package
lxpack build --target xapi
Build cmi5 package
lxpack build --target cmi5
Typical workflow after editing files
lxpack validate
lxpack preview
lxpack build --target scorm12

Reference

Other tracks