|
1 | | -# Starlight Starter Kit: Basics |
| 1 | +# 📚 Daxa Documentation |
2 | 2 |
|
3 | | -[](https://starlight.astro.build) |
| 3 | +Welcome to the official documentation site for [Daxa](https://github.com/Ipotrick/Daxa). |
4 | 4 |
|
5 | | -``` |
6 | | -npm create astro@latest -- --template starlight |
7 | | -``` |
8 | | - |
9 | | -> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun! |
| 5 | +--- |
10 | 6 |
|
11 | | -## 🚀 Project Structure |
| 7 | +## 🗂️ Project Structure |
12 | 8 |
|
13 | | -Inside of your Astro + Starlight project, you'll see the following folders and files: |
| 9 | +This repository follows the [Starlight](https://starlight.astro.build/) documentation framework. Below are the key directories for managing content: |
14 | 10 |
|
| 11 | +```text |
| 12 | +src/ |
| 13 | +└── content/ |
| 14 | + └── docs/ |
| 15 | + ├── tutorial/ # All tutorial markdown files |
| 16 | + └── wiki/ # All wiki markdown files |
15 | 17 | ``` |
16 | | -. |
17 | | -├── public/ |
18 | | -├── src/ |
19 | | -│ ├── assets/ |
20 | | -│ ├── content/ |
21 | | -│ │ └── docs/ |
22 | | -│ └── content.config.ts |
23 | | -├── astro.config.mjs |
24 | | -├── package.json |
25 | | -└── tsconfig.json |
26 | | -``` |
27 | 18 |
|
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. |
| 19 | +--- |
| 20 | + |
| 21 | +## ✍️ Writing Documentation |
29 | 22 |
|
30 | | -Images can be added to `src/assets/` and embedded in Markdown with a relative link. |
| 23 | +- **Tutorials:** |
| 24 | + Place step-by-step learning materials in `src/content/docs/tutorial`. |
31 | 25 |
|
32 | | -Static assets, like favicons, can be placed in the `public/` directory. |
| 26 | +- **Wiki Pages:** |
| 27 | + Store in-depth articles, explanations, and references in `src/content/docs/wiki`. |
33 | 28 |
|
34 | | -## 🧞 Commands |
| 29 | +Each `.md` or `.mdx` file will be automatically integrated into the site's sidebar and routing. |
35 | 30 |
|
36 | | -All commands are run from the root of the project, from a terminal: |
| 31 | +--- |
37 | 32 |
|
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 | |
| 33 | +## 🚀 Getting Started (Development & Preview) |
46 | 34 |
|
47 | | -## 👀 Want to learn more? |
| 35 | +Install dependencies and run the local dev server: |
48 | 36 |
|
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). |
| 37 | +```bash |
| 38 | +npm install |
| 39 | +npm run dev |
| 40 | +``` |
0 commit comments