Repository navigation
1.3.0
-
The theme comment in the shipped
course.config.ymlpointed at
docs/customization.md; the guide isdocs/customisation.md. A course made
from an earlier release keeps its own copy of the file, so fix the path there
by hand if it bothers you. -
Course: Check in the command palette runs
npx course checkin the shared
terminal, the way Course: Validate does. Palette only, like Course:
Build Glossary: no entry in the Course Manager tree or its menus.
check-linkshas no entry of its own, since Check runs it. -
npx course checkruns every pre-ship check in one go and exits non-zero
naming the ones that failed:validate;build-glossary --checkwhen the
course keeps a glossary at the default path, skipped and said so when it does
not, since the glossary command fails without one;check-links; and every
entry ofchecks.extraincourse.config.yml. Each runs as its own process,
so one failure does not stop the rest.npm run hooks:installinstalls it as
a git pre-push hook, and.github/workflows/course-checks.ymlruns it in
place ofvalidatealone, so a course's CI now covers glossary freshness, the
plain link check and the course's own extras as well. -
npx course check-linksreports every relative markdown or image link whose
target does not exist on disk, under the folderschecks.links.rootsnames
(coursealone by default) or a repeated--root.validateresolves the
links between the items it scans and nothing else, socourse/index.md,
course/LICENSE.md, a folder nested deeper than a module takes and any
markdown kept outsidecourse/went unchecked; this is the plain filesystem
check beside it. Code blocks and inline code are ignored, external URLs and
site-absolute paths are left alone, and the run lists every broken link and
exits non-zero when there is one. -
course.config.ymltakes achecks:section for the pre-ship checks.
links.rootslists the folderscheck-linksscans for broken relative links,
coursealone unless a course says otherwise;extralists the subcommands
checkruns after its built-in list, so a course that registered a command of
its own (a games build, say) has it gated by the same command and the same
pre-push hook without patching the tooling after every update. A value of the
wrong shape warns and falls back, entry by entry where it can, like every
other key in the file.