|
1 | | -# Starlight Starter Kit: Basics |
| 1 | +# NextFTC v2 Docs (Beta) |
2 | 2 |
|
3 | 3 | [](https://starlight.astro.build) |
4 | 4 |
|
5 | | -``` |
6 | | -bun create astro@latest -- --template starlight |
7 | | -``` |
8 | | - |
9 | | -> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun! |
| 5 | +Documentation site for **NextFTC v2**, built with [Astro](https://astro.build) and [Starlight](https://starlight.astro.build). Deployed to [beta.nextftc.dev](https://beta.nextftc.dev). |
10 | 6 |
|
11 | 7 | ## 🚀 Project Structure |
12 | 8 |
|
13 | | -Inside of your Astro + Starlight project, you'll see the following folders and files: |
14 | | - |
15 | 9 | ``` |
16 | 10 | . |
17 | 11 | ├── public/ |
18 | 12 | ├── src/ |
19 | 13 | │ ├── assets/ |
20 | 14 | │ ├── content/ |
21 | 15 | │ │ └── docs/ |
| 16 | +│ ├── styles/ |
| 17 | +│ │ └── custom.css |
22 | 18 | │ └── content.config.ts |
23 | 19 | ├── astro.config.mjs |
24 | 20 | ├── package.json |
25 | 21 | └── tsconfig.json |
26 | 22 | ``` |
27 | 23 |
|
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. |
| 24 | +Starlight looks for `.md` or `.mdx` files in `src/content/docs/`. Each file is exposed as a route based on its file name. |
29 | 25 |
|
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. |
| 26 | +Images can be added to `src/assets/` and embedded in Markdown with a relative link. Static assets, like favicons, go in `public/`. |
33 | 27 |
|
34 | 28 | ## 🧞 Commands |
35 | 29 |
|
36 | 30 | All commands are run from the root of the project, from a terminal: |
37 | 31 |
|
38 | | -| Command | Action | |
39 | | -| :------------------------ | :----------------------------------------------- | |
40 | | -| `bun install` | Installs dependencies | |
41 | | -| `bun dev` | Starts local dev server at `localhost:4321` | |
42 | | -| `bun build` | Build your production site to `./dist/` | |
43 | | -| `bun preview` | Preview your build locally, before deploying | |
44 | | -| `bun astro ...` | Run CLI commands like `astro add`, `astro check` | |
45 | | -| `bun astro -- --help` | Get help using the Astro CLI | |
| 32 | +| Command | Action | |
| 33 | +| :------------------- | :------------------------------------------------ | |
| 34 | +| `bun install` | Installs dependencies | |
| 35 | +| `bun dev` | Starts local dev server at `localhost:4321` | |
| 36 | +| `bun run build` | Build the production site to `./dist/` | |
| 37 | +| `bun preview` | Preview the build locally, before deploying | |
| 38 | +| `bun astro ...` | Run CLI commands like `astro add`, `astro check` | |
| 39 | +| `bun astro -- --help` | Get help using the Astro CLI | |
| 40 | + |
| 41 | +## Deployment |
| 42 | + |
| 43 | +Pushes to `main` are built and deployed to GitHub Pages automatically via `.github/workflows/deploy.yaml`. |
46 | 44 |
|
47 | 45 | ## 👀 Want to learn more? |
48 | 46 |
|
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). |
| 47 | +Check out [Starlight's docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [NextFTC Discord server](https://nextftc.dev/discord). |
0 commit comments