starlight-nutshell

astro-nutshell

Make expandable explanations using nutshell.js.

Documentation

Getting Started

A Starlight plugin to add a Nutshell to your documentation site.

• Adds expandable explanations using nutshell.js.

Check out the demo for a preview of the Nutshell.

Prerequisites

You will need to have a Starlight website set up. If you don’t have one yet, you can follow the “Getting Started” guide in the Starlight docs to create one.

Installation

Starlight Nutshell is a Starlight plugin. Install it using your favorite package manager:

npm

npm i starlight-nutshell

pnpm

pnpm add starlight-nutshell

yarn

yarn add starlight-nutshell

Configuration

Configure the plugin in your Starlight configuration file (astro.config.mjs).

// astro.config.mjs
import starlight from "@astrojs/starlight";
import { defineConfig } from "astro/config";
import starlightNutshell from "starlight-nutshell";

export default defineConfig({
  integrations: [
    starlight({
      plugins: [starlightNutshell()],
      title: "My Docs",
    }),
  ],
});

License

Licensed under the MIT License, Copyright © jojokcreator.

See LICENSE for more information.