These are the docs of the development version (the devel branch). See the docs of the latest release.

starlight-theme

One Astro + Starlight setup for the docs of the max-models projects, shown here on a small example package.

$ npx --package github:max-models/starlight-theme starlight-theme-init

What the theme brings

Config

defineDocs writes the Astro config: base path, math, API reference, link check.

Look

The paper/ink palette with a teal accent, a header with section links, and this header picture, drawn anew for each site.

Notebooks

starlight-notebooks executes notebooks and turns them into pages.

Gallery

starlight-gallery runs example scripts and shows their figures in a grid.

Getting startedUse the theme in a project.

TutorialsA converted notebook.

GalleryFigures from example scripts.

DevelopmentBuild the docs and write examples.

APIGenerated from the docstrings.