-
-
Notifications
You must be signed in to change notification settings - Fork 126
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
42 changed files
with
11,282 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
name: Deploy Docs to GitHub Pages | ||
|
||
on: | ||
push: | ||
paths: | ||
- 'docs/**' | ||
|
||
permissions: | ||
contents: read | ||
pages: write | ||
id-token: write | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout your repository using git | ||
uses: actions/checkout@v3 | ||
- name: Install, build, and upload your site | ||
uses: withastro/action@v1 | ||
with: | ||
path: ./docs # The root location of your Astro project inside the repository. (optional) | ||
|
||
deploy: | ||
needs: build | ||
runs-on: ubuntu-latest | ||
environment: | ||
name: github-pages | ||
url: ${{ steps.deployment.outputs.page_url }} | ||
steps: | ||
- name: Deploy to GitHub Pages | ||
id: deployment | ||
uses: actions/deploy-pages@v1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# build output | ||
dist/ | ||
# generated types | ||
.astro/ | ||
|
||
# dependencies | ||
node_modules | ||
|
||
# logs | ||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
pnpm-debug.log* | ||
|
||
|
||
# environment variables | ||
.env | ||
.env.production | ||
|
||
# macOS-specific files | ||
.DS_Store |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# Developing | ||
|
||
```bash | ||
npm install | ||
npm run dev | ||
``` | ||
|
||
## Sidebar | ||
|
||
To edit the side bar edit `astro.config.mjs` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
import { defineConfig } from 'astro/config'; | ||
import starlight from '@astrojs/starlight'; | ||
|
||
const base = '/ags-docs'; | ||
|
||
const config = [ | ||
'Installation', | ||
'JavaScript', | ||
'First Widgets', | ||
'Reactivity', | ||
'Theeming', | ||
'Config Object', | ||
'Type Checking', | ||
'CLI', | ||
'Widgets', | ||
'Variables', | ||
'Services', | ||
'Utils', | ||
'Custom Service', | ||
'Subclassing GTK Widgets', | ||
'Examples', | ||
]; | ||
|
||
const widgets = [ | ||
'Window', | ||
'Box', | ||
'Button', | ||
'CenterBox', | ||
'CircularProgress', | ||
'Entry', | ||
'EventBox', | ||
'Icon', | ||
'Label', | ||
'Overlay', | ||
'ProgressBar', | ||
'Revealer', | ||
'Scrollable', | ||
'Slider', | ||
'Stack', | ||
'Menu', | ||
'MenuItem', | ||
]; | ||
|
||
// https://astro.build/config | ||
export default defineConfig({ | ||
site: 'https://aylur.github.io', | ||
base, | ||
integrations: [ | ||
starlight({ | ||
title: 'AGS Wiki', | ||
editLink: { | ||
baseUrl: 'https://github.com/Aylur/ags/docs/', | ||
}, | ||
social: { | ||
github: 'https://github.com/Aylur/ags', | ||
discord: 'https://discord.gg/CXQpHwDuhY', | ||
}, | ||
customCss: ['./src/styles/custom.css'], | ||
sidebar: [ | ||
{ | ||
label: 'Configuration', | ||
items: config.map(label => ({ | ||
label, link: 'config/' + label.toLowerCase().replaceAll(' ', '-'), | ||
})), | ||
}, | ||
{ | ||
label: 'Builtin Services', | ||
collapsed: true, | ||
autogenerate: { directory: '/services' }, | ||
}, | ||
{ | ||
label: 'Builtin Widgets', | ||
collapsed: true, | ||
items: widgets.map(label => ({ | ||
label, link: 'config/widgets#' + label.toLowerCase(), | ||
})), | ||
}, | ||
], | ||
}), | ||
], | ||
}); |
Oops, something went wrong.