Skip to content

Commit b91c194

Browse files
committed
moving docs
1 parent 82b89be commit b91c194

191 files changed

Lines changed: 12865 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/Dockerfile

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
FROM nginx
2+
COPY dist /usr/share/nginx/html
3+
COPY nginx.conf /etc/nginx/conf.d/default.conf
4+
5+
# docker build -t europe-west4-docker.pkg.dev/small-storage1/databases-and-such/refact-ai:20230825 .

docs/README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Starlight Starter Kit: Basics
2+
3+
```
4+
npm create astro@latest -- --template starlight
5+
```
6+
7+
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)
8+
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)
9+
10+
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
11+
12+
## 🚀 Project Structure
13+
14+
Inside of your Astro + Starlight project, you'll see the following folders and files:
15+
16+
```
17+
.
18+
├── public/
19+
├── src/
20+
│ ├── assets/
21+
│ ├── content/
22+
│ │ ├── docs/
23+
│ │ └── config.ts
24+
│ └── env.d.ts
25+
├── astro.config.mjs
26+
├── package.json
27+
└── tsconfig.json
28+
```
29+
30+
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.
31+
32+
Images can be added to `src/assets/` and embedded in Markdown with a relative link.
33+
34+
Static assets, like favicons, can be placed in the `public/` directory.
35+
36+
## 🧞 Commands
37+
38+
All commands are run from the root of the project, from a terminal:
39+
40+
| Command | Action |
41+
| :------------------------ | :----------------------------------------------- |
42+
| `npm install` | Installs dependencies |
43+
| `npm run dev` | Starts local dev server at `localhost:4321` |
44+
| `npm run build` | Build your production site to `./dist/` |
45+
| `npm run preview` | Preview your build locally, before deploying |
46+
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
47+
| `npm run astro -- --help` | Get help using the Astro CLI |
48+
49+
## 👀 Want to learn more?
50+
51+
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).

0 commit comments

Comments
 (0)