- All pages need to be updated content-wise
- Port over resources hosted on Sharepoint or GDrive
- Update landing page quick links
- Create "How to contribute to this wiki" page
- On intro page, change tech area bullet list links to tiles
- Add currently hidden guides to sidebar
- Use Starlight's built-in 'steps' component for tutorials
- Filtering out pages depending if you are an end user or a peer instructor (maybe a toggle in top toolbar)
- Button toggle light/dark theme rather than dropdown
- Ability to display pages as as sub-items (similar to gitbook and notion)
- Toggle collapsable dropdown page component
- Carousel item with captions
- Youtube playlist component
- Create category related links templates for bottom of the page
- Sidebar manual ordering of pages
- Heading link icon click to copy
Guides lead a user through a specific task they want to accomplish, often with a sequence of steps. Writing a good guide requires thinking about what your users are trying to do.
Read about how-to guides in the Diátaxis framework
Reference pages are ideal for outlining how things work in terse and clear terms. Less concerned with telling a story or addressing a specific use case, they should give a comprehensive outline of what you're documenting.
Read about reference in the Diátaxis framework
Inside of your Astro + Starlight project, you'll see the following folders and files:
.
├── public/
├── src/
│ ├── assets/
│ ├── content/
│ │ ├── docs/
│ │ └── config.ts
│ └── env.d.ts
├── astro.config.mjs
├── package.json
└── tsconfig.json
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.
Images can be added to src/assets/ and embedded in Markdown with a relative link.
Static assets, like favicons, can be placed in the public/ directory.
All commands are run from the root of the project, from a terminal:
| Command | Action |
|---|---|
npm install |
Installs dependencies |
npm run dev |
Starts local dev server at localhost:4321 |
npm run build |
Build your production site to ./dist/ |
npm run preview |
Preview your build locally, before deploying |
npm run astro ... |
Run CLI commands like astro add, astro check |
npm run astro -- --help |
Get help using the Astro CLI |
Check out Starlight’s docs, read the Astro documentation, or jump into the Astro Discord server.
More sites/pages that have been immense help