Select the types of activity you want to include in your feed.
[READ-ONLY] Mirror of https://github.com/trueberryless/starlight-customize-toc-additional-content. Add additional content to Starlight's table of contents.
···11+# Starlight Starter Kit: Basics
22+33+[](https://starlight.astro.build)
44+55+```
66+pnpm create astro@latest -- --template starlight
77+```
88+99+> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun!
1010+1111+## 🚀 Project Structure
1212+1313+Inside of your Astro + Starlight project, you'll see the following folders and files:
1414+1515+```
1616+.
1717+├── public/
1818+├── src/
1919+│ ├── assets/
2020+│ ├── content/
2121+│ │ └── docs/
2222+│ └── content.config.ts
2323+├── astro.config.mjs
2424+├── package.json
2525+└── tsconfig.json
2626+```
2727+2828+Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
2929+3030+Images can be added to `src/assets/` and embedded in Markdown with a relative link.
3131+3232+Static assets, like favicons, can be placed in the `public/` directory.
3333+3434+## 🧞 Commands
3535+3636+All commands are run from the root of the project, from a terminal:
3737+3838+| Command | Action |
3939+| :------------------------ | :----------------------------------------------- |
4040+| `pnpm install` | Installs dependencies |
4141+| `pnpm dev` | Starts local dev server at `localhost:4321` |
4242+| `pnpm build` | Build your production site to `./dist/` |
4343+| `pnpm preview` | Preview your build locally, before deploying |
4444+| `pnpm astro ...` | Run CLI commands like `astro add`, `astro check` |
4545+| `pnpm astro -- --help` | Get help using the Astro CLI |
4646+4747+## 👀 Want to learn more?
4848+4949+Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).
···11+---
22+title: Example Guide
33+description: A guide in my new Starlight docs site.
44+---
55+66+Guides lead a user through a specific task they want to accomplish, often with a sequence of steps.
77+Writing a good guide requires thinking about what your users are trying to do.
88+99+## Further reading
1010+1111+- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework
···11+---
22+title: Welcome to Starlight
33+description: Get started building your docs site with Starlight.
44+template: splash # Remove or comment out this line to display the site sidebar on this page.
55+hero:
66+ tagline: Congrats on setting up a new Starlight project!
77+ image:
88+ file: ../../assets/houston.webp
99+ actions:
1010+ - text: Example Guide
1111+ link: /guides/example/
1212+ icon: right-arrow
1313+ - text: Read the Starlight docs
1414+ link: https://starlight.astro.build
1515+ icon: external
1616+ variant: minimal
1717+---
1818+1919+import { Card, CardGrid } from '@astrojs/starlight/components';
2020+2121+## Next steps
2222+2323+<CardGrid stagger>
2424+ <Card title="Update content" icon="pencil">
2525+ Edit `src/content/docs/index.mdx` to see this page change.
2626+ </Card>
2727+ <Card title="Change page layout" icon="document">
2828+ Delete `template: splash` in `src/content/docs/index.mdx` to display a
2929+ sidebar on this page.
3030+ </Card>
3131+ <Card title="Add new content" icon="add-document">
3232+ Add Markdown or MDX files to `src/content/docs` to create new pages.
3333+ </Card>
3434+ <Card title="Configure your site" icon="setting">
3535+ Edit your `sidebar` and other config in `astro.config.mjs`.
3636+ </Card>
3737+ <Card title="Read the docs" icon="open-book">
3838+ Learn more in [the Starlight Docs](https://starlight.astro.build/).
3939+ </Card>
4040+</CardGrid>
···11+---
22+title: Example Reference
33+description: A reference page in my new Starlight docs site.
44+---
55+66+Reference pages are ideal for outlining how things work in terse and clear terms.
77+Less concerned with telling a story or addressing a specific use case, they should give a comprehensive outline of what you're documenting.
88+99+## Further reading
1010+1111+- Read [about reference](https://diataxis.fr/reference/) in the Diátaxis framework