Skip to content

Commit 4b2282e

Browse files
committed
add docs
1 parent e661ab1 commit 4b2282e

20 files changed

+10109
-12402
lines changed

.github/workflows/deploy.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ jobs:
2121
- name: Checkout your repository using git
2222
uses: actions/checkout@v3
2323
- name: Install, build, and upload your site
24-
uses: withastro/action@v0
24+
uses: withastro/action@v1
2525
with:
26-
node-version: 18
26+
node-version: 20
2727

2828
deploy:
2929
needs: build

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# build output
22
dist/
3+
.astro/
34
.output/
45

56
# dependencies

README-docs.md

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

astro.config.mjs

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,45 @@
11
import { defineConfig } from 'astro/config';
2+
import starlight from '@astrojs/starlight';
23
import react from '@astrojs/react';
34
import tailwind from "@astrojs/tailwind";
45

56
export default defineConfig({
67
site: 'https://codegenie.codes',
7-
integrations: [react(), tailwind()]
8+
integrations: [
9+
react(),
10+
tailwind(),
11+
starlight({
12+
title: 'Code Genie',
13+
description: 'Full stack application generator',
14+
logo: {
15+
src: './src/assets/images/code-genie-logo.webp'
16+
},
17+
social: {
18+
github: 'https://github.com/CodeGenieApp',
19+
},
20+
editLink: {
21+
baseUrl: 'https://github.com/CodeGenieApp/docs/edit/main/',
22+
},
23+
lastUpdated: true,
24+
sidebar: [
25+
{
26+
label: 'Guides',
27+
items: [
28+
{ label: 'Getting Started', link: '/docs/guides/getting-started' },
29+
],
30+
},
31+
{
32+
label: 'Project Structure',
33+
items: [
34+
{ label: 'Overview', link: '/docs/project-structure/overview' },
35+
{ label: 'UI/Frontend', link: '/docs/project-structure/ui-frontend' },
36+
{ label: 'API/Backend', link: '/docs/project-structure/api-backend' },
37+
{ label: 'Database', link: '/docs/project-structure/database' },
38+
{ label: 'Auth/Identity', link: '/docs/project-structure/auth-identity' },
39+
{ label: 'Cloud Infrastructure', link: '/docs/project-structure/cloud-infrastructure' },
40+
{ label: 'Deploying', link: '/docs/project-structure/deploying' },
41+
],
42+
},
43+
],
44+
}),]
845
});

env.d.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
/// <reference path="../.astro/types.d.ts" />
2+
/// <reference types="astro/client" />

0 commit comments

Comments
 (0)