Skip to content

Commit 6ef558c

Browse files
feat: README.md
1 parent 11558f2 commit 6ef558c

File tree

1 file changed

+26
-35
lines changed

1 file changed

+26
-35
lines changed

README.md

Lines changed: 26 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,40 @@
1-
# Starlight Starter Kit: Basics
1+
# 📚 Daxa Documentation
22

3-
[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
3+
Welcome to the official documentation site for [Daxa](https://github.com/Ipotrick/Daxa).
44

5-
```
6-
npm create astro@latest -- --template starlight
7-
```
8-
9-
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
5+
---
106

11-
## 🚀 Project Structure
7+
## 🗂️ Project Structure
128

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:
1410

11+
```text
12+
src/
13+
└── content/
14+
└── docs/
15+
├── tutorial/ # All tutorial markdown files
16+
└── wiki/ # All wiki markdown files
1517
```
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-
```
2718

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
2922

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`.
3125

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`.
3328

34-
## 🧞 Commands
29+
Each `.md` or `.mdx` file will be automatically integrated into the site's sidebar and routing.
3530

36-
All commands are run from the root of the project, from a terminal:
31+
---
3732

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)
4634

47-
## 👀 Want to learn more?
35+
Install dependencies and run the local dev server:
4836

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

Comments
 (0)