Skip to content

Commit ec9d517

Browse files
committed
add astro
1 parent 1af3446 commit ec9d517

File tree

8 files changed

+423
-7865
lines changed

8 files changed

+423
-7865
lines changed

.github/workflows/deploy.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ on:
44
# Trigger the workflow every time you push to the `main` branch
55
# Using a different branch name? Replace `main` with your branch’s name
66
push:
7-
branches: [main]
7+
branches: [ main ]
88
# Allows you to run this workflow manually from the Actions tab on GitHub.
99
workflow_dispatch:
1010

@@ -20,12 +20,12 @@ jobs:
2020
steps:
2121
- name: Checkout your repository using git
2222
uses: actions/checkout@v4
23-
- name: Install, build, and upload your site output
24-
uses: withastro/action@v2
23+
- name: Install, build, and upload your site
24+
uses: withastro/action@v3
2525
# 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 18. (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)
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)
2929

3030
deploy:
3131
needs: build

astro.config.mjs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ import starlight from '@astrojs/starlight';
33

44
// https://astro.build/config
55
export default defineConfig({
6+
site: 'https://pengios.github.io/docs',
7+
base: 'PengiOS/Docs',
68
integrations: [
79
starlight({
810
title: 'My Docs',

package-lock.json

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

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"astro": "astro"
1111
},
1212
"dependencies": {
13-
"@astrojs/starlight": "^0.28.2",
13+
"@astrojs/starlight": "^0.28.3",
1414
"astro": "^4.15.3",
1515
"sharp": "^0.32.5"
1616
}

public/favicon.svg

Lines changed: 1 addition & 1 deletion
Loading
File renamed without changes.

src/content/docs/reference/example.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: Example Reference
3+
description: A reference page in my new Starlight docs site.
4+
---
5+
6+
Reference pages are ideal for outlining how things work in terse and clear terms.
7+
Less concerned with telling a story or addressing a specific use case, they should give a comprehensive outline of what you're documenting.
8+
9+
## Further reading
10+
11+
- Read [about reference](https://diataxis.fr/reference/) in the Diátaxis framework

0 commit comments

Comments
 (0)