Skip to content

Commit deef787

Browse files
committed
docs: add docs (#69)
1 parent 16622b7 commit deef787

26 files changed

+1547
-73
lines changed

apps/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

apps/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+
}

apps/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+
}

apps/docs/README.md

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

apps/docs/astro.config.mjs

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
// @ts-check
2+
3+
import starlight from "@astrojs/starlight";
4+
import { defineConfig } from "astro/config";
5+
6+
// https://astro.build/config
7+
export default defineConfig({
8+
site: "https://docs.albertplus.com",
9+
integrations: [
10+
starlight({
11+
title: "AlbertPlus Docs",
12+
social: [
13+
{
14+
icon: "github",
15+
label: "GitHub",
16+
href: "https://github.com/TechAtNYU/AlbertPlus",
17+
},
18+
{
19+
icon: "discord",
20+
label: "Discord",
21+
href: "https://discord.gg/z8p4Qtjatw",
22+
},
23+
],
24+
editLink: {
25+
baseUrl: "https://github.com/TechAtNYU/AlbertPlus/edit/main/apps/docs",
26+
},
27+
sidebar: [
28+
{ label: "Overview", slug: "overview" },
29+
{
30+
label: "Getting Started",
31+
items: [
32+
{ label: "Quick Start", slug: "getting-started/quick-start" },
33+
{
34+
label: "Environment Variables",
35+
slug: "getting-started/environment-variables",
36+
},
37+
{ label: "Tech Stack", slug: "getting-started/tech-stack" },
38+
],
39+
},
40+
{
41+
label: "Architecture",
42+
items: [
43+
{ label: "Overview", slug: "architecture/overview" },
44+
{ label: "Monorepo Structure", slug: "architecture/monorepo" },
45+
{ label: "Data Flow", slug: "architecture/data-flow" },
46+
{ label: "Authentication", slug: "architecture/authentication" },
47+
],
48+
},
49+
{
50+
label: "Modules",
51+
items: [
52+
{ label: "Web App", slug: "modules/web-app" },
53+
{
54+
label: "Browser Extension",
55+
slug: "modules/browser-extension",
56+
},
57+
{ label: "Scraper", slug: "modules/scraper" },
58+
{ label: "Convex", slug: "modules/convex" },
59+
{ label: "Documentation", slug: "modules/documentation" },
60+
],
61+
},
62+
],
63+
}),
64+
],
65+
});

apps/docs/biome.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"root": false,
3+
"$schema": "https://biomejs.dev/schemas/2.3.2/schema.json",
4+
"extends": "//",
5+
"files": {
6+
"includes": ["**", "!node_modules"]
7+
},
8+
"html": {
9+
"formatter": { "enabled": true },
10+
"experimentalFullSupportEnabled": true
11+
}
12+
}

apps/docs/package.json

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
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+
"check": "biome check"
12+
},
13+
"dependencies": {
14+
"@astrojs/starlight": "^0.36.1",
15+
"astro": "^5.6.1",
16+
"sharp": "^0.34.2"
17+
},
18+
"devDependencies": {
19+
"@biomejs/biome": "2.3.2"
20+
}
21+
}

apps/docs/public/favicon.svg

Lines changed: 1 addition & 0 deletions
Loading

apps/docs/src/assets/houston.webp

96.2 KB
Loading

apps/docs/src/content.config.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
import { defineCollection } from "astro:content";
2+
import { docsLoader } from "@astrojs/starlight/loaders";
3+
import { docsSchema } from "@astrojs/starlight/schema";
4+
5+
export const collections = {
6+
docs: defineCollection({ loader: docsLoader(), schema: docsSchema() }),
7+
};

0 commit comments

Comments
 (0)