🎉 Initial commit

Author: Schneegans

.github/workflows/deploy.yml

@@ -0,0 +1,38 @@
+name: Deploy to GitHub Pages
+
+on:
+  # Trigger the workflow every time you push to the `main` branch
+  push:
+    branches: [main]
+  # Allows you to run this workflow manually from the Actions tab on GitHub.
+  workflow_dispatch:
+
+# Allow this job to clone the repo and create a page deployment
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout your repository using git
+        uses: actions/checkout@v4
+      - name: Install, build, and upload your site
+        uses: withastro/action@v3
+        # with:
+        # path: . # The root location of your Astro project inside the repository. (optional)
+        # node-version: 20 # The specific version of Node that should be used to build your site. Defaults to 20. (optional)
+        # 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)
+
+  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@v4

.gitignore

@@ -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

.prettierrc.yaml

@@ -0,0 +1,11 @@
+# SPDX-FileCopyrightText: Simon Schneegans <[email protected]>
+# SPDX-License-Identifier: CC0-1.0
+
+trailingComma: 'es5'
+printWidth: 90
+semi: true
+singleQuote: true
+bracketSameLine: true
+singleAttributePerLine: false
+useTabs: false
+tabWidth: 2

README.md

@@ -1 +1,19 @@
-# cosmoscout.github.io
+# The Homepage of [CosmoScout VR](https://github.com/cosmoscout/cosmoscout-vr)
+
+> [!IMPORTANT]  
+> This page is currently under construction! It will receive more content and major updates.
+
+Feel free to improve the documentation by submitting a pull request to this repository.
+If you want to preview your changes locally, you only need to clone your fork and run the following commands:
+
+```bash
+npm install
+npm run dev
+```
+
+This will start a local development server at http://localhost:4321.
+
+## Documentation
+
+This page uses the [Starlight](https://starlight.astro.build/getting-started/) theme for the [Astro](https://docs.astro.build/en/getting-started/) framework to generate static HTML files.
+You can find some documentation about the frameworks by using these links.

astro.config.mjs

@@ -0,0 +1,59 @@
+// @ts-check
+import starlight from '@astrojs/starlight';
+import icon from 'astro-icon';
+import { defineConfig } from 'astro/config';
+
+// https://astro.build/config
+export default defineConfig({
+  site: 'https://cosmoscout.github.io',
+  integrations: [
+    icon(),
+    starlight({
+      title: 'CosmoScout VR',
+      logo: {
+        src: './src/assets/cosmoscout.svg',
+        alt: 'CosmoScout VR Logo',
+      },
+      editLink: {
+        baseUrl: 'https://github.com/cosmoscout/cosmoscout.github.io/edit/main/',
+      },
+      social: {
+        github: 'https://github.com/cosmoscout/cosmoscout-vr',
+      },
+      sidebar: [
+        {
+          label: 'Getting Started',
+          autogenerate: { directory: 'getting-started' },
+        },
+        {
+          label: 'Getting Involved',
+          autogenerate: { directory: 'getting-involved' },
+        },
+        {
+          label: 'Plugins',
+          autogenerate: { directory: 'plugins' },
+        },
+        {
+          label: 'Issue Tracker 🗗',
+          link: 'https://github.com/cosmoscout/cosmoscout-vr/issues',
+          attrs: { target: '_blank' },
+        },
+        {
+          label: 'Changelog 🗗',
+          link: 'https://github.com/cosmoscout/cosmoscout-vr/blob/main/docs/changelog.md',
+          attrs: { target: '_blank' },
+        },
+        {
+          label: 'Code of Conduct 🗗',
+          link: 'https://github.com/cosmoscout/cosmoscout-vr/blob/main/docs/code_of_conduct.md',
+          attrs: { target: '_blank' },
+        },
+      ],
+      lastUpdated: true,
+      customCss: ['./src/styles/custom.css'],
+      components: {
+        Footer: './src/components/Footer.astro',
+      },
+    }),
+  ],
+});