Skip to content

Commit 4651d81

Browse files
burningtreeburningtree
committed
first commit
0 parents  commit 4651d81

File tree

17 files changed

+8410
-0
lines changed

17 files changed

+8410
-0
lines changed

‎.github/workflows/deploy.yaml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
# Trigger the workflow every time you push to the `main` branch
5+
# Using a different branch name? Replace `main` with your branch’s name
6+
push:
7+
branches: [ main ]
8+
# Allows you to run this workflow manually from the Actions tab on GitHub.
9+
workflow_dispatch:
10+
11+
# Allow this job to clone the repo and create a page deployment
12+
permissions:
13+
contents: read
14+
pages: write
15+
id-token: write
16+
17+
jobs:
18+
build:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- name: Checkout your repository using git
22+
uses: actions/checkout@v4
23+
- name: Install, build, and upload your site
24+
uses: withastro/action@v2
25+
# with:
26+
# path: . # The root location of your Astro project inside the repository. (optional)
27+
# node-version: 20 # The specific version of Node that should be used to build your site. Defaults to 20. (optional)
28+
# package-manager: pnpm@latest # The Node package manager that should be used to install dependencies and build your site. Automatically detected based on your lockfile. (optional)
29+
30+
deploy:
31+
needs: build
32+
runs-on: ubuntu-latest
33+
environment:
34+
name: github-pages
35+
url: ${{ steps.deployment.outputs.page_url }}
36+
steps:
37+
- name: Deploy to GitHub Pages
38+
id: deployment
39+
uses: actions/deploy-pages@v4

‎.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

‎.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+
}

‎.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+
}

‎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 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)
12+
13+
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
14+
15+
## 🚀 Project Structure
16+
17+
Inside of your Astro + Starlight project, you'll see the following folders and files:
18+
19+
```
20+
.
21+
├── public/
22+
├── src/
23+
│ ├── assets/
24+
│ ├── content/
25+
│ │ ├── docs/
26+
│ │ └── config.ts
27+
│ └── env.d.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).

‎astro.config.mjs

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
import { defineConfig } from 'astro/config';
2+
import starlight from '@astrojs/starlight';
3+
4+
// https://astro.build/config
5+
export default defineConfig({
6+
site: 'https://docs.evermeet.app',
7+
integrations: [
8+
starlight({
9+
title: 'evermeet Docs',
10+
social: {
11+
github: 'https://github.com/evermeet/evermeet',
12+
},
13+
sidebar: [
14+
{
15+
label: 'Introduction',
16+
items: [
17+
{ label: 'Getting Started', link: '/' },
18+
],
19+
},
20+
{
21+
label: 'Features',
22+
items: [
23+
{ label: 'Event Management', link: '/features/event-management' },
24+
{ label: 'Ticket Sales and Registration', link: '/features/ticket-sales' },
25+
{ label: 'Speaker and Program Management', link: '/features/speaker-management' },
26+
{ label: 'Payment Processing', link: '/features/payment-processing' }
27+
]
28+
},
29+
{
30+
label: 'Federation',
31+
items: [
32+
{ label: 'Federation Overview', link: '/federation/overview' },
33+
{ label: 'Portable Identifiers (DID)', link: '/federation/portable-identifiers' },
34+
]
35+
},
36+
{
37+
label: 'Deployment',
38+
items: [
39+
{ label: 'Choosing a Deployment Method', link: '/deployment/methods' },
40+
{ label: 'Third-party Hosting', link: '/deployment/third-parties' },
41+
{ label: 'Docker (recommended)', link: '/deployment/docker' },
42+
{ label: 'Manual Deployment', link: '/deployment/manual' },
43+
{ label: 'Backup & Restore', link: '/deployment/backup-restore' },
44+
{ label: 'Customizations and Extensions', link: '/deployment/customizations' },
45+
{ label: 'Performance Optimization', link: '/deployment/performance' },
46+
{ label: 'Common Issues and Solutions', link: '/deployment/common-issues' }
47+
]
48+
},
49+
{
50+
label: 'Developers',
51+
items: [
52+
{ label: 'System Architecture', link: '/developers/system-architecture' },
53+
{ label: 'Contributing Guidelines', link: '/developers/contributing' },
54+
{ label: 'Local Development Setup', link: '/developers/local-setup' },
55+
{ label: 'API Endpoints', link: '/developers/api-endpoints' },
56+
]
57+
},
58+
{
59+
label: 'Release Notes',
60+
items: [
61+
{ label: 'Version History', link: '/release-notes/version-history' },
62+
{ label: 'Future Plans', link: '/release-notes/future-plans' }
63+
]
64+
},
65+
],
66+
67+
}),
68+
],
69+
});

0 commit comments

Comments
 (0)