Skip to content

1.6.0

Choose a tag to compare

@github-actions github-actions released this 24 Oct 12:34
· 9 commits to main since this release
d978b43
  • 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.yml instead 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 as CC-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.yml sets license: CC-BY-NC-SA-4.0 to match
    course/LICENSE.md. An existing course keeps its own course.config.yml,
    which has no footer: block, so its next build shows the same copyright line
    plus the new credit, and no button. To drop the credit, add footer: with
    credit: false; to show the button, add license: with the identifier of the
    licence in your course/LICENSE.md.
    The Site Footer has the details.

  • npx course setup asks for the website footer's notice and licence, after the
    export style. The wizard used to leave the new footer: 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
    none for no notice) and lets you pick the licence button from the seven
    Creative Commons licences or none, 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 in course.config.yml survives. 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 setup writes the course title, tagline, language and
    theme at the top level of course.config.yml only. It used to rewrite the
    first line that set the key at any indentation, so a course with an active
    labels: block that overrides glossary.title and 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.