Skip to content

Commit 58ae354

Browse files
committed
init
1 parent 1be7249 commit 58ae354

15 files changed

+4597
-2
lines changed

.gitattributes

-2
This file was deleted.

.gitignore

+21
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

.vscode/extensions.json

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

.vscode/launch.json

+11
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+
}

README.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
## 🚀 Project Structure
2+
3+
Inside of your Astro + Starlight project, you'll see the following folders and files:
4+
5+
```
6+
.
7+
├── public/
8+
├── src/
9+
│ ├── assets/
10+
│ ├── content/
11+
│ │ ├── docs/
12+
│ └── content.config.ts
13+
├── astro.config.mjs
14+
├── package.json
15+
└── tsconfig.json
16+
```
17+
18+
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+
Images can be added to `src/assets/` and embedded in Markdown with a relative link.
21+
22+
Static assets, like favicons, can be placed in the `public/` directory.
23+
24+
## 🧞 Commands
25+
26+
All commands are run from the root of the project, from a terminal:
27+
28+
| Command | Action |
29+
| :------------------------ | :----------------------------------------------- |
30+
| `pnpm install` | Installs dependencies |
31+
| `pnpm dev` | Starts local dev server at `localhost:4321` |
32+
| `pnpm build` | Build your production site to `./dist/` |
33+
| `pnpm preview` | Preview your build locally, before deploying |
34+
| `pnpm astro ...` | Run CLI commands like `astro add`, `astro check` |
35+
| `pnpm astro -- --help` | Get help using the Astro CLI |

astro.config.mjs

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
// @ts-check
2+
import { defineConfig } from "astro/config";
3+
import starlight from "@astrojs/starlight";
4+
5+
// https://astro.build/config
6+
export default defineConfig({
7+
redirects: {
8+
"/": "/how/custom_classes",
9+
},
10+
integrations: [
11+
starlight({
12+
title: "Godot Rust FAQ",
13+
lastUpdated:true,
14+
15+
social: [
16+
{
17+
icon: "github",
18+
label: "GitHub",
19+
href: "https://github.com/ColinWttt/godot-rust-faq",
20+
},
21+
],
22+
sidebar: [
23+
{
24+
label: "How to",
25+
items: [
26+
"how/custom_classes",
27+
"how/interact_classes",
28+
"how/communicate_godot",
29+
],
30+
},
31+
{
32+
label: "Common Errors",
33+
items: [
34+
"errors/errors",
35+
],
36+
},
37+
],
38+
}),
39+
],
40+
});

package.json

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"name": "",
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/starlight": "^0.33.0",
14+
"astro": "^5.5.3",
15+
"sharp": "^0.32.5"
16+
}
17+
}

0 commit comments

Comments
 (0)