Skip to content

Commit 1d9a5b0

Browse files
committed
Convert docs-site from submodule to regular directory
- Remove submodule reference for docs-site - Add all documentation files as regular tracked files - Preserves all existing documentation content
1 parent 5e5ff53 commit 1d9a5b0

37 files changed

+16994
-1
lines changed

docs-site

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs-site/.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-site/README.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
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+
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight&create_from_path=examples/basics)
12+
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Fbasics&project-name=my-starlight-docs&repository-name=my-starlight-docs)
13+
14+
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
15+
16+
## 🚀 Project Structure
17+
18+
Inside of your Astro + Starlight project, you'll see the following folders and files:
19+
20+
```
21+
.
22+
├── public/
23+
├── src/
24+
│ ├── assets/
25+
│ ├── content/
26+
│ │ ├── docs/
27+
│ └── content.config.ts
28+
├── astro.config.mjs
29+
├── package.json
30+
└── tsconfig.json
31+
```
32+
33+
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.
34+
35+
Images can be added to `src/assets/` and embedded in Markdown with a relative link.
36+
37+
Static assets, like favicons, can be placed in the `public/` directory.
38+
39+
## 🧞 Commands
40+
41+
All commands are run from the root of the project, from a terminal:
42+
43+
| Command | Action |
44+
| :------------------------ | :----------------------------------------------- |
45+
| `npm install` | Installs dependencies |
46+
| `npm run dev` | Starts local dev server at `localhost:4321` |
47+
| `npm run build` | Build your production site to `./dist/` |
48+
| `npm run preview` | Preview your build locally, before deploying |
49+
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
50+
| `npm run astro -- --help` | Get help using the Astro CLI |
51+
52+
## 👀 Want to learn more?
53+
54+
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-site/astro.config.mjs

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
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+
site: 'https://dgellow.github.io',
8+
base: '/mcp-front',
9+
integrations: [
10+
starlight({
11+
title: 'MCP Front',
12+
description: 'OAuth 2.1 authenticated proxy for Model Context Protocol servers',
13+
logo: {
14+
alt: 'MCP Front Logo',
15+
src: './src/assets/logo.svg',
16+
},
17+
social: [
18+
{ icon: 'github', label: 'GitHub', href: 'https://github.com/dgellow/mcp-front' },
19+
],
20+
sidebar: [
21+
{
22+
label: 'Start Here',
23+
items: [
24+
{ label: 'Introduction', slug: 'index' },
25+
{ label: 'Getting Started', slug: 'getting-started' },
26+
{ label: 'Architecture', slug: 'architecture' },
27+
],
28+
},
29+
{
30+
label: 'Configuration',
31+
items: [
32+
{ label: 'Overview', slug: 'config/overview' },
33+
{ label: 'Bearer Token Auth', slug: 'config/bearer-token' },
34+
{ label: 'OAuth 2.1 Auth', slug: 'config/oauth' },
35+
{ label: 'MCP Servers', slug: 'config/mcp-servers' },
36+
{ label: 'Environment Variables', slug: 'config/environment' },
37+
],
38+
},
39+
{
40+
label: 'Deployment',
41+
items: [
42+
{ label: 'Docker', slug: 'deployment/docker' },
43+
{ label: 'Docker Compose', slug: 'deployment/docker-compose' },
44+
{ label: 'Google Cloud Run', slug: 'deployment/cloud-run' },
45+
{ label: 'Production Setup', slug: 'deployment/production' },
46+
],
47+
},
48+
{
49+
label: 'OAuth Guide',
50+
items: [
51+
{ label: 'OAuth 2.1 Overview', slug: 'oauth/overview' },
52+
{ label: 'Google Workspace Setup', slug: 'oauth/google-workspace' },
53+
{ label: 'Firestore Configuration', slug: 'oauth/firestore' },
54+
{ label: 'Security Best Practices', slug: 'oauth/security' },
55+
],
56+
},
57+
{
58+
label: 'API Reference',
59+
items: [
60+
{ label: 'Endpoints', slug: 'api/endpoints' },
61+
{ label: 'Authentication', slug: 'api/authentication' },
62+
{ label: 'SSE Protocol', slug: 'api/sse-protocol' },
63+
],
64+
},
65+
{
66+
label: 'Development',
67+
items: [
68+
{ label: 'Testing', slug: 'dev/testing' },
69+
{ label: 'Architecture Decisions', slug: 'dev/architecture-decisions' },
70+
],
71+
},
72+
],
73+
customCss: ['./src/styles/custom.css'],
74+
}),
75+
],
76+
});

docs-site/docs-site/README.md

Whitespace-only changes.
Lines changed: 174 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)