Skip to content

Commit d6933cc

Browse files
committed
docs
0 parents  commit d6933cc

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+11249
-0
lines changed

.gitignore

+21
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

README.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Developing
2+
3+
```bash
4+
npm install
5+
npm run dev
6+
```
7+
8+
## Sidebar
9+
10+
To edit the side bar edit `astro.config.mjs`

astro.config.mjs

+81
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
import { defineConfig } from 'astro/config';
2+
import starlight from '@astrojs/starlight';
3+
4+
const base = '/ags-docs';
5+
6+
const config = [
7+
'Installation',
8+
'JavaScript',
9+
'First Widgets',
10+
'Reactivity',
11+
'Theeming',
12+
'Config Object',
13+
'Type Checking',
14+
'CLI',
15+
'Widgets',
16+
'Variables',
17+
'Services',
18+
'Utils',
19+
'Custom Service',
20+
'Subclassing GTK Widgets',
21+
'Examples',
22+
];
23+
24+
const widgets = [
25+
'Window',
26+
'Box',
27+
'Button',
28+
'CenterBox',
29+
'CircularProgress',
30+
'Entry',
31+
'EventBox',
32+
'Icon',
33+
'Label',
34+
'Overlay',
35+
'ProgressBar',
36+
'Revealer',
37+
'Scrollable',
38+
'Slider',
39+
'Stack',
40+
'Menu',
41+
'MenuItem',
42+
];
43+
44+
// https://astro.build/config
45+
export default defineConfig({
46+
site: 'https://aylur.github.io',
47+
base,
48+
integrations: [
49+
starlight({
50+
title: 'AGS Wiki',
51+
editLink: {
52+
baseUrl: 'https://github.com/Aylur/ags/docs/',
53+
},
54+
social: {
55+
github: 'https://github.com/Aylur/ags',
56+
discord: 'https://discord.gg/CXQpHwDuhY',
57+
},
58+
customCss: ['./src/styles/custom.css'],
59+
sidebar: [
60+
{
61+
label: 'Configuration',
62+
items: config.map(label => ({
63+
label, link: 'config/' + label.toLowerCase().replaceAll(' ', '-'),
64+
})),
65+
},
66+
{
67+
label: 'Builtin Services',
68+
collapsed: true,
69+
autogenerate: { directory: '/services' },
70+
},
71+
{
72+
label: 'Builtin Widgets',
73+
collapsed: true,
74+
items: widgets.map(label => ({
75+
label, link: 'config/widgets#' + label.toLowerCase(),
76+
})),
77+
},
78+
],
79+
}),
80+
],
81+
});

0 commit comments

Comments
 (0)