|
1 | | -# Starlight Starter Kit: Basics |
| 1 | +# agent-sh.dev |
2 | 2 |
|
3 | | -[](https://starlight.astro.build) |
| 3 | +Landing site for the agent-sh organization. Static Astro 5 site deployed to `agent-sh.github.io`. |
4 | 4 |
|
5 | | -``` |
6 | | -npm create astro@latest -- --template starlight |
7 | | -``` |
8 | | - |
9 | | -> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun! |
10 | | -
|
11 | | -## 🚀 Project Structure |
12 | | - |
13 | | -Inside of your Astro + Starlight project, you'll see the following folders and files: |
| 5 | +## Structure |
14 | 6 |
|
15 | 7 | ``` |
16 | 8 | . |
17 | | -├── public/ |
18 | | -├── src/ |
19 | | -│ ├── assets/ |
20 | | -│ ├── content/ |
21 | | -│ │ └── docs/ |
22 | | -│ └── content.config.ts |
23 | | -├── astro.config.mjs |
24 | | -├── package.json |
25 | | -└── tsconfig.json |
| 9 | +├── ORG_ARCHITECTURE.md Architecture decision record |
| 10 | +├── astro.config.mjs Site config (base: /) |
| 11 | +├── public/ Static assets |
| 12 | +└── src/ |
| 13 | + ├── components/ |
| 14 | + │ ├── Nav.astro Top navigation with Products dropdown |
| 15 | + │ └── Footer.astro Site footer |
| 16 | + ├── data/ |
| 17 | + │ ├── plugins.json Plugin catalog data |
| 18 | + │ └── skills.json Skills directory data |
| 19 | + ├── layouts/ |
| 20 | + │ └── Base.astro Base HTML layout |
| 21 | + ├── pages/ |
| 22 | + │ ├── index.astro Landing page - hero, stats, products, philosophy |
| 23 | + │ ├── docs.astro Documentation hub linking to all product docs |
| 24 | + │ ├── plugins.astro Plugin catalog with filters |
| 25 | + │ └── skills.astro Skills directory with search |
| 26 | + └── styles/ |
| 27 | + ├── tokens.css Design tokens (canonical source for all sites) |
| 28 | + └── main.css Site styles |
26 | 29 | ``` |
27 | 30 |
|
28 | | -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. |
29 | | - |
30 | | -Images can be added to `src/assets/` and embedded in Markdown with a relative link. |
31 | | - |
32 | | -Static assets, like favicons, can be placed in the `public/` directory. |
33 | | - |
34 | | -## 🧞 Commands |
| 31 | +## Commands |
35 | 32 |
|
36 | | -All commands are run from the root of the project, from a terminal: |
| 33 | +| Command | Action | |
| 34 | +| :------------------ | :------------------------------------------ | |
| 35 | +| `npm install` | Install dependencies | |
| 36 | +| `npm run dev` | Start local dev server at localhost:4321 | |
| 37 | +| `npm run build` | Build production site to ./dist/ | |
| 38 | +| `npm run preview` | Preview build locally before deploying | |
37 | 39 |
|
38 | | -| Command | Action | |
39 | | -| :------------------------ | :----------------------------------------------- | |
40 | | -| `npm install` | Installs dependencies | |
41 | | -| `npm run dev` | Starts local dev server at `localhost:4321` | |
42 | | -| `npm run build` | Build your production site to `./dist/` | |
43 | | -| `npm run preview` | Preview your build locally, before deploying | |
44 | | -| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | |
45 | | -| `npm run astro -- --help` | Get help using the Astro CLI | |
| 40 | +## Deployment |
46 | 41 |
|
47 | | -## 👀 Want to learn more? |
| 42 | +Deployed to GitHub Pages via `.github/workflows/deploy.yml`. Base path is `/`. |
48 | 43 |
|
49 | | -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). |
| 44 | +See [ORG_ARCHITECTURE.md](./ORG_ARCHITECTURE.md) for the full architecture decision record covering URL structure, frameworks, design tokens, and future work. |
0 commit comments