Skip to content

Commit 966df77

Browse files
committed
Add docs project with Astro Starlight
1 parent 9cdcda5 commit 966df77

13 files changed

Lines changed: 5044 additions & 0 deletions

File tree

docs/.gitignore

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# build output
2+
dist/
3+
# generated types
4+
.astro/
5+
6+
# dependencies
7+
node_modules/
8+
9+
# logs
10+
npm-debug.log*
11+
yarn-debug.log*
12+
yarn-error.log*
13+
pnpm-debug.log*
14+
15+
16+
# environment variables
17+
.env
18+
.env.production
19+
20+
# macOS-specific files
21+
.DS_Store

docs/.vscode/extensions.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"recommendations": ["astro-build.astro-vscode"],
3+
"unwantedRecommendations": []
4+
}

docs/.vscode/launch.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"version": "0.2.0",
3+
"configurations": [
4+
{
5+
"command": "./node_modules/.bin/astro dev",
6+
"name": "Development server",
7+
"request": "launch",
8+
"type": "node-terminal"
9+
}
10+
]
11+
}

docs/README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# AxisEndpoints docs
2+
3+
This project is documentation page for AxisEndpoints built with Asto Starlight.
4+
5+
[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
6+
7+
## Project Structure
8+
9+
Inside of your Astro + Starlight project, you'll see the following folders and files:
10+
11+
```
12+
.
13+
├── public/
14+
├── src/
15+
│ ├── assets/
16+
│ ├── content/
17+
│ │ └── docs/
18+
│ └── content.config.ts
19+
├── astro.config.mjs
20+
├── package.json
21+
└── tsconfig.json
22+
```
23+
24+
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.
25+
26+
Images can be added to `src/assets/` and embedded in Markdown with a relative link.
27+
28+
Static assets, like favicons, can be placed in the `public/` directory.
29+
30+
## Commands
31+
32+
All commands are run from the root of the project, from a terminal:
33+
34+
| Command | Action |
35+
| :------------------------ | :----------------------------------------------- |
36+
| `pnpm install` | Installs dependencies |
37+
| `pnpm dev` | Starts local dev server at `localhost:4321` |
38+
| `pnpm build` | Build your production site to `./dist/` |
39+
| `pnpm preview` | Preview your build locally, before deploying |
40+
| `pnpm astro ...` | Run CLI commands like `astro add`, `astro check` |
41+
| `pnpm astro -- --help` | Get help using the Astro CLI |
42+
43+
## Learn more
44+
45+
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).

docs/astro.config.mjs

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
// @ts-check
2+
import { defineConfig } from "astro/config";
3+
import starlight from "@astrojs/starlight";
4+
import starlightThemeNord from "starlight-theme-nord";
5+
import react from "@astrojs/react";
6+
import tailwindcss from "@tailwindcss/vite";
7+
8+
// https://astro.build/config
9+
export default defineConfig({
10+
integrations: [
11+
starlight({
12+
title: "AxisEndpoints",
13+
social: [
14+
{
15+
icon: "github",
16+
label: "GitHub",
17+
href: "https://github.com/sheepla/AxisEndpoints",
18+
},
19+
],
20+
sidebar: [
21+
//
22+
],
23+
}),
24+
react(),
25+
],
26+
27+
vite: {
28+
plugins: [tailwindcss(), starlightThemeNord()],
29+
},
30+
});

docs/package.json

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{
2+
"name": "docs",
3+
"type": "module",
4+
"version": "0.0.1",
5+
"scripts": {
6+
"dev": "astro dev",
7+
"start": "astro dev",
8+
"build": "astro build",
9+
"preview": "astro preview",
10+
"astro": "astro"
11+
},
12+
"dependencies": {
13+
"@astrojs/react": "^5.0.4",
14+
"@astrojs/starlight": "^0.38.4",
15+
"@tailwindcss/vite": "^4.2.4",
16+
"@types/react": "^19.2.14",
17+
"@types/react-dom": "^19.2.3",
18+
"astro": "^6.1.9",
19+
"react": "^19.2.5",
20+
"react-dom": "^19.2.5",
21+
"sharp": "^0.34.5",
22+
"starlight-theme-nord": "^0.1.4",
23+
"tailwindcss": "^4.2.4"
24+
}
25+
}

0 commit comments

Comments
 (0)