Skip to content

Commit 3af91bd

Browse files
openscriptopenscript
committed
chore: add example content
1 parent 227f920 commit 3af91bd

File tree

16 files changed

+115
-48
lines changed

16 files changed

+115
-48
lines changed

‎README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,8 @@
33
To set up the course template, follow these steps:
44

55
1. Use repository as a template
6+
1. Clone the repository
7+
1. Open the repository in a code editor
8+
1. Reopen inside the dev container
9+
1. Enable GitHub Actions
10+
1. Enable GitHub Pages

‎astro.config.mjs

Lines changed: 33 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,47 @@ import starlightThemeOpenscript from 'starlight-theme-openscript'
77
export default defineConfig({
88
integrations: [
99
starlight({
10+
defaultLocale: 'de',
11+
locales: {
12+
root: {
13+
label: 'Deutsch',
14+
lang: 'de', // lang is required for root locales
15+
},
16+
},
1017
plugins: [starlightThemeOpenscript()],
1118
title: '[Company] [Coursename]',
12-
social: [{ icon: 'github', label: 'GitHub', href: 'https://github.com/withastro/starlight' }],
19+
logo: {
20+
src: './src/assets/logo.svg',
21+
alt: '[Company] [Coursename]',
22+
},
23+
social: [{ icon: 'document', label: 'Webseite', href: 'https://openscript.ch' }],
1324
sidebar: [
1425
{
15-
label: 'Guides',
26+
label: 'Organisatorisches',
1627
items: [
17-
// Each item here is one entry in the navigation menu.
18-
{ label: 'Example Guide', slug: 'guides/example' },
28+
{ label: 'Ablauf', slug: 'org/schedule' },
29+
{ label: 'Präsentation', slug: 'org/presentation' },
1930
],
2031
},
2132
{
22-
label: 'Reference',
23-
autogenerate: { directory: 'reference' },
33+
label: 'Tag 1',
34+
autogenerate: { directory: 'part1' },
35+
},
36+
{
37+
label: 'Tag 2',
38+
autogenerate: { directory: 'part2' },
39+
},
40+
{
41+
label: 'Tag 3',
42+
autogenerate: { directory: 'part3' },
43+
},
44+
{
45+
label: 'Tag 4',
46+
autogenerate: { directory: 'part4' },
47+
},
48+
{
49+
label: 'Tag 5',
50+
autogenerate: { directory: 'part5' },
2451
},
2552
],
2653
}),

‎package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515
"dependencies": {
1616
"@astrojs/starlight": "^0.34.3",
1717
"astro": "^5.9.2",
18-
"sharp": "^0.34.0",
19-
"starlight-theme-openscript": "^0.1.6"
18+
"sharp": "^0.34.2",
19+
"starlight-theme-openscript": "^0.1.8"
2020
},
2121
"devDependencies": {
2222
"@changesets/cli": "^2.29.4"

‎pnpm-lock.yaml

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

‎src/assets/houston.webp

-96.2 KB
Binary file not shown.

‎src/assets/logo.svg

Lines changed: 20 additions & 0 deletions
Loading

‎src/assets/splash.svg

Lines changed: 1 addition & 0 deletions
Loading

‎src/content/docs/guides/example.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎src/content/docs/index.mdx

Lines changed: 27 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,40 @@
11
---
2-
title: Welcome to Starlight
3-
description: Get started building your docs site with Starlight.
2+
title: "[Title]"
3+
description: "[Tagline]"
44
template: splash
55
hero:
6-
tagline: Congrats on setting up a new Starlight project!
6+
tagline: "[Tagline]"
77
image:
8-
file: ../../assets/houston.webp
8+
file: ../../assets/splash.svg
99
actions:
10-
- text: Example Guide
11-
link: /guides/example/
10+
- text: Ablauf
11+
link: ./org/schedule/
1212
icon: right-arrow
13-
- text: Read the Starlight docs
14-
link: https://starlight.astro.build
15-
icon: external
13+
- text: Präsentation
14+
link: ./org/presentation/
15+
icon: document
1616
variant: minimal
1717
---
1818

19-
import { Card, CardGrid } from '@astrojs/starlight/components';
19+
import { Card, CardGrid, LinkCard } from '@astrojs/starlight/components';
2020

21-
## Next steps
21+
## Ablauf
2222

2323
<CardGrid stagger>
24-
<Card title="Update content" icon="pencil">
25-
Edit `src/content/docs/index.mdx` to see this page change.
26-
</Card>
27-
<Card title="Add new content" icon="add-document">
28-
Add Markdown or MDX files to `src/content/docs` to create new pages.
29-
</Card>
30-
<Card title="Configure your site" icon="setting">
31-
Edit your `sidebar` and other config in `astro.config.mjs`.
32-
</Card>
33-
<Card title="Read the docs" icon="open-book">
34-
Learn more in [the Starlight Docs](https://starlight.astro.build/).
35-
</Card>
24+
<LinkCard href="./part1/" title="Tag 1" description="[Beschreibung Tag 1]" />
25+
<LinkCard href="./part2/" title="Tag 2" description="[Beschreibung Tag 2]" />
26+
<LinkCard href="./part3/" title="Tag 3" description="[Beschreibung Tag 3]" />
27+
<LinkCard href="./part4/" title="Tag 4" description="[Beschreibung Tag 4]" />
28+
<LinkCard href="./part5/" title="Tag 5" description="[Beschreibung Tag 5]" />
3629
</CardGrid>
30+
31+
## Kurse
32+
33+
<CardGrid>
34+
<LinkCard href="./day1/" title="Kurs XY" />
35+
<LinkCard href="./day2/" title="Kurs AB" />
36+
</CardGrid>
37+
38+
## Weiteres
39+
40+
Erstellt für [Beispielfirma](https://example.com) von [openscript GmbH](https://openscript.ch).

‎src/content/docs/org/presentation.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Präsentation
3+
description: A reference page in my new Starlight docs site.
4+
---
5+
6+

0 commit comments

Comments
 (0)