Skip to content

Install

Install the theme for Starlight.

  1. Install the theme package to your project with your preferred package manager:

    Terminal window
    npm install toolbeam-docs-theme @fontsource/ibm-plex-mono

    Optionally, install packages for linked headings.

    Terminal window
    npm install @astrojs/markdown-remark rehype-autolink-headings
  2. Add the theme to your Starlight config.

    astro.config.mjs
    import theme from "toolbeam-docs-theme";
    import { rehypeHeadingIds } from "@astrojs/markdown-remark";
    import rehypeAutolinkHeadings from "rehype-autolink-headings";
    export default defineConfig({
    // ...
    integrations: [
    starlight({
    // ...
    plugins: [theme()],
    }),
    ],
    // Optional, linked headings
    markdown: {
    rehypePlugins: [
    rehypeHeadingIds,
    [rehypeAutolinkHeadings, { behavior: "wrap" }],
    ],
    },
    });