https://github.com/nihaiden/aurora-docs-v2
https://github.com/nihaiden/aurora-docs-v2
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/nihaiden/aurora-docs-v2
- Owner: NiHaiden
- Created: 2024-09-28T20:13:29.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-11-15T00:18:54.000Z (6 months ago)
- Last Synced: 2024-11-15T00:29:25.233Z (6 months ago)
- Language: JavaScript
- Size: 321 KB
- Stars: 2
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Aurora Docs
[](https://starlight.astro.build)
## 🚀 Project Structure
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.
# Adding a new guide
Create a file in `src/contents/docs/guides`.
Add it as a route to `astro.config.mjs` so it appears in the sidebar. Choose a short name and use `guides/mdfile` as the slug.
## 🧞 Commands
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 |
## 👀 Want to learn more?
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).