Repository navigation
1.6.0
-
The tutorial's Setting Up pages say where Coursewright comes from. What
You Need opened with the four installs and never named the project, and
Your Course Project linked it only as "the Coursewright project page", so
a visitor reading coursewright.md had to go back to the home page to find the
GitHub address. What You Need now opens with the address and says you get
Coursewright by copying that project rather than installing it, and Your
Course Project spells the address out in its first step. A course syncing
this repository to Canvas sees the two pages reported as modified locally
once. -
The website footer is set in
course.config.ymlinstead of
docusaurus.config.js. It used to read "Copyright © 2026" and nothing else,
and changing it meant editing a file every upstream update overwrites. A new
footer:block takes a notice of your own in one line of markdown (text,
with{year}for the year of the build), a Creative Commons licence button
linking to its deed (license, an SPDX identifier such asCC-BY-NC-SA-4.0),
and a "Made with Coursewright" link to the project (credit). The buttons
load from the Creative Commons press-kit mirror rather than shipping with the
template, because they are Creative Commons trademarks. The footer is the
website's alone: exports and Canvas do not carry it. The template's
course.config.ymlsetslicense: CC-BY-NC-SA-4.0to match
course/LICENSE.md. An existing course keeps its owncourse.config.yml,
which has nofooter:block, so its next build shows the same copyright line
plus the new credit, and no button. To drop the credit, addfooter:with
credit: false; to show the button, addlicense:with the identifier of the
licence in yourcourse/LICENSE.md.
The Site Footer has the details. -
npx course setupasks for the website footer's notice and licence, after the
export style. The wizard used to leave the newfooter:block alone, so the
one place a course states who wrote it and under which licence had to be found
and edited by hand. It now offers the current notice as the default (answer
nonefor no notice) and lets you pick the licence button from the seven
Creative Commons licences ornone, with a reminder to keep it in step with
course/LICENSE.md. An entry is written only when your answer changes it, and
every comment incourse.config.ymlsurvives. Two new flags answer the
questions from a script:--footer <text>and--license <id|none>, which
stops with an error naming the valid identifiers on anything else. The summary
line after the run names the licence. -
npx course setupwrites the coursetitle,tagline,languageand
themeat the top level ofcourse.config.ymlonly. It used to rewrite the
first line that set the key at any indentation, so a course with an active
labels:block that overridesglossary.titleand sits above the top-level
title:had its glossary heading replaced by the course name, and the course
name left as it was. Nested keys are now left alone.