neuromatch-course-kit

The nma-kit command line for Neuromatch courses written in MyST Markdown. It is one half of the Neuromatch course kit; the other half is the MyST plugin on npm, @neuromatch/course-kit. Both ship under the same version.

Courses usually don't install this by hand: the reusable GitHub workflows in the kit repository do. To use it locally:

uv venv && uv pip install -r requirements.txt "neuromatch-course-kit==0.1.*"
uv run nma-kit check
uv run myst start

Requires Python 3.10 or newer. Run every command from the course root (the folder with myst.yml).

Commands

Exit codes: 0 ok, 1 content problems or a failed publish, 2 usage or configuration errors.

Settings

Read from myst.yml: project.github gives the repository, and the optional top-level nma: block holds the rest.

nma:
  paths:
    tutorials: tutorials          # where the tutorial .md pages live
    projects: projects            # where the project .md pages live
  notebooks:
    branch: notebooks-branch      # where generated notebooks are published
  feedback:                       # required if any page uses {nma-feedback}
    url: https://...
    project: ...
    user_key: ...
  brand:                          # site colours, "#RRGGBB" each (see below)
    primary: "#008CBF"
  style:
    extra: _static/extra.css      # your own CSS, appended after the kit's

Site branding

sync-assets writes _nma/site.css, logo.svg, logo-dark.svg and favicon.png. List them in myst.yml:

site:
  options:
    style: _nma/site.css
    logo: _nma/logo.svg
    logo_dark: _nma/logo-dark.svg
    favicon: _nma/favicon.png

The stylesheet is the kit's (Neuromatch palette, Rubik embedded, so the kit's own CSS makes no font requests, styles for the kit's widgets), then your nma.brand colours, then your nma.style.extra CSS. Brand keys: primary, primary_hover, primary_light, secondary, accent. Setting only primary derives the hover and light variants. _nma/ ignores itself, so don't commit it; run sync-assets again after upgrading the kit.

Values in nma: must be plain strings in one level of sections.

Versions

The kit is on 0.x. A breaking change bumps the minor version, so ==0.1.* only receives compatible fixes. The CLI and the npm plugin always share a version number, and prepare-site pins the plugin URL to the CLI's own version.

Source, docs and release process: https://github.com/neuromatch/course-kit.

BSD-3-Clause.