Skip to content
starlight-theme

Installation

In the project’s docs/:

Terminal window
npm install github:max-models/starlight-theme#v0.1.0

docs/astro.config.mjs then only holds what is particular to the project:

import { defineDocs } from '@max-models/starlight-theme';


export default defineDocs({
  repo: 'simgeometry',
  title: 'simgeometry',
  description: 'Shapes, structured grids, and domains for numerical simulations.',
  pythonPackage: 'simgeometry',
  nav: [
    { label: 'Getting started', link: '/getting-started/installation/' },
    { label: 'Tutorials', link: '/tutorials/' },
    { label: 'API', link: '/api/simgeometry/', section: '/api/' },
  ],
  sidebar: [/* ... */],
});

Inline math such as eiπ+1=0e^{i\pi} + 1 = 0 works in every page, and so does display math:

∇⋅E=ρε0.\nabla \cdot \mathbf{E} = \frac{\rho}{\varepsilon_0}.