Skip to content

Commit 0740dd2

Browse files
committed
update readme + pages deploy
1 parent debc90c commit 0740dd2

5 files changed

Lines changed: 60 additions & 114 deletions

File tree

.github/workflows/deploy.yaml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
jobs:
14+
build:
15+
runs-on: ubuntu-latest
16+
steps:
17+
- name: Checkout
18+
uses: actions/checkout@v7
19+
20+
- name: Build Documentation
21+
uses: withastro/action@v6
22+
23+
deploy:
24+
needs: build
25+
runs-on: ubuntu-latest
26+
environment:
27+
name: github-pages
28+
url: ${{ steps.deployment.outputs.page_url }}
29+
steps:
30+
- name: Deploy to GitHub Pages
31+
id: deployment
32+
uses: actions/deploy-pages@v5

.idea/workspace.xml

Lines changed: 7 additions & 93 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 19 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,47 @@
1-
# Starlight Starter Kit: Basics
1+
# NextFTC v2 Docs (Beta)
22

33
[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
44

5-
```
6-
bun create astro@latest -- --template starlight
7-
```
8-
9-
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
5+
Documentation site for **NextFTC v2**, built with [Astro](https://astro.build) and [Starlight](https://starlight.astro.build). Deployed to [beta.nextftc.dev](https://beta.nextftc.dev).
106

117
## 🚀 Project Structure
128

13-
Inside of your Astro + Starlight project, you'll see the following folders and files:
14-
159
```
1610
.
1711
├── public/
1812
├── src/
1913
│ ├── assets/
2014
│ ├── content/
2115
│ │ └── docs/
16+
│ ├── styles/
17+
│ │ └── custom.css
2218
│ └── content.config.ts
2319
├── astro.config.mjs
2420
├── package.json
2521
└── tsconfig.json
2622
```
2723

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.
24+
Starlight looks for `.md` or `.mdx` files in `src/content/docs/`. Each file is exposed as a route based on its file name.
2925

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.
26+
Images can be added to `src/assets/` and embedded in Markdown with a relative link. Static assets, like favicons, go in `public/`.
3327

3428
## 🧞 Commands
3529

3630
All commands are run from the root of the project, from a terminal:
3731

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 |
32+
| Command | Action |
33+
| :------------------- | :------------------------------------------------ |
34+
| `bun install` | Installs dependencies |
35+
| `bun dev` | Starts local dev server at `localhost:4321` |
36+
| `bun run build` | Build the production site to `./dist/` |
37+
| `bun preview` | Preview the build locally, before deploying |
38+
| `bun astro ...` | Run CLI commands like `astro add`, `astro check` |
39+
| `bun astro -- --help` | Get help using the Astro CLI |
40+
41+
## Deployment
42+
43+
Pushes to `main` are built and deployed to GitHub Pages automatically via `.github/workflows/deploy.yaml`.
4644

4745
## 👀 Want to learn more?
4846

49-
Check out [Starlights docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).
47+
Check out [Starlight's docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [NextFTC Discord server](https://nextftc.dev/discord).

astro.config.mjs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ import starlight from '@astrojs/starlight';
44

55
// https://astro.build/config
66
export default defineConfig({
7+
site: 'https://beta.nextftc.dev',
78
integrations: [
89
starlight({
910
title: 'NextFTC',

public/CNAME

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
beta.nextftc.dev

0 commit comments

Comments
 (0)