feat: new documentation (#149)

Author: johanohly

.github/workflows/deploy-docs.yml

@@ -37,13 +37,12 @@ jobs:
       - name: Upload Build Artifact
         uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3
         with:
-          path: docs/build/
+          path: docs/dist/
 
   deploy:
     name: Deploy to GitHub Pages
     needs: build
 
-    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
     permissions:
       pages: write # to deploy to Pages
       id-token: write # to verify the deployment originates from an appropriate source

.prettierrc

@@ -3,13 +3,19 @@
   "singleQuote": true,
   "useTabs": false,
   "trailingComma": "all",
-  "plugins": ["prettier-plugin-svelte"],
+  "plugins": ["prettier-plugin-svelte", "prettier-plugin-astro"],
   "overrides": [
     {
       "files": "*.svelte",
       "options": {
         "parser": "svelte"
       }
+    },
+    {
+      "files": "*.astro",
+      "options": {
+        "parser": "astro"
+      }
     }
   ]
 }

bun.lockb

@@ -17,7 +17,7 @@ services:
       timeout: 5s
       retries: 5
     ports:
-      - "5432:5432"
+      - '5432:5432'
 
 volumes:
   db_data:

docker/development/compose.yml

@@ -1,20 +1,21 @@
-# Dependencies
-/node_modules
+# build output
+dist/
+# generated types
+.astro/
 
-# Production
-/build
-
-# Generated files
-.docusaurus
-.cache-loader
-
-# Misc
-.DS_Store
-.env.local
-.env.development.local
-.env.test.local
-.env.production.local
+# 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

docs/.gitignore

@@ -1,41 +1,55 @@
-# Website
+# Starlight Starter Kit: Basics
 
-This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
-
-### Installation
+[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
 
 ```
-$ yarn
+npm create astro@latest -- --template starlight
 ```
 
-### Local Development
+[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)
+[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)
+[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight&create_from_path=examples/basics)
+[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Fbasics&project-name=my-starlight-docs&repository-name=my-starlight-docs)
 
-```
-$ yarn start
-```
+> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
 
-This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+## 🚀 Project Structure
 
-### Build
+Inside of your Astro + Starlight project, you'll see the following folders and files:
 
 ```
-$ yarn build
+.
+├── public/
+├── src/
+│   ├── assets/
+│   ├── content/
+│   │   ├── docs/
+│   │   └── config.ts
+│   └── env.d.ts
+├── astro.config.mjs
+├── package.json
+└── tsconfig.json
 ```
 
-This command generates static content into the `build` directory and can be served using any static contents hosting service.
+Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
 
-### Deployment
+Images can be added to `src/assets/` and embedded in Markdown with a relative link.
 
-Using SSH:
+Static assets, like favicons, can be placed in the `public/` directory.
 
-```
-$ USE_SSH=true yarn deploy
-```
+## 🧞 Commands
 
-Not using SSH:
+All commands are run from the root of the project, from a terminal:
 
-```
-$ GIT_USER=<Your GitHub username> yarn deploy
-```
+| Command                   | Action                                           |
+| :------------------------ | :----------------------------------------------- |
+| `npm install`             | Installs dependencies                            |
+| `npm run dev`             | Starts local dev server at `localhost:4321`      |
+| `npm run build`           | Build your production site to `./dist/`          |
+| `npm run preview`         | Preview your build locally, before deploying     |
+| `npm run astro ...`       | Run CLI commands like `astro add`, `astro check` |
+| `npm run astro -- --help` | Get help using the Astro CLI                     |
+
+## 👀 Want to learn more?
 
-If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
+Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).

docs/README.md

@@ -0,0 +1,81 @@
+// @ts-check
+import react from '@astrojs/react';
+import starlight from '@astrojs/starlight';
+import tailwind from '@astrojs/tailwind';
+import { defineConfig } from 'astro/config';
+import starlightImageZoom from 'starlight-image-zoom';
+import starlightLinksValidator from 'starlight-links-validator';
+
+// https://astro.build/config
+export default defineConfig({
+  site: 'https://airtrail.johan.ohly.dk',
+  integrations: [
+    starlight({
+      title: 'AirTrail',
+      description: 'A modern, open-source personal flight tracking system',
+      logo: {
+        dark: '@/assets/airtrail-logo-light.png',
+        light: '@/assets/airtrail-logo.png',
+      },
+      customCss: ['@/styles/globals.css'],
+      social: {
+        github: 'https://github.com/johanohly/AirTrail',
+      },
+      sidebar: [
+        {
+          label: 'Overview',
+          items: [
+            'docs/overview/introduction',
+            'docs/overview/quick-start',
+            'docs/overview/contributing',
+          ],
+        },
+        {
+          label: 'Install',
+          items: [
+            'docs/install/requirements',
+            'docs/install/one-click',
+            'docs/install/docker-compose',
+            'docs/install/portainer',
+            'docs/install/synology',
+            'docs/install/manual',
+            'docs/install/post-installation',
+            'docs/install/updating',
+          ],
+        },
+        {
+          label: 'Features',
+          items: [
+            'docs/features/add-flight',
+            'docs/features/statistics',
+            'docs/features/import',
+            'docs/features/export',
+            'docs/features/oauth',
+          ],
+        },
+        {
+          label: 'Development',
+          items: ['docs/development/contributing-guidelines'],
+        },
+      ],
+      lastUpdated: true,
+      editLink: {
+        baseUrl: 'https://github.com/johanohly/AirTrail/edit/main/docs',
+      },
+      favicon: '/favicon.png',
+      plugins: [
+        starlightLinksValidator({ errorOnRelativeLinks: false }),
+        starlightImageZoom(),
+      ],
+      components: {
+        SocialIcons: '@/components/overrides/SocialIcons.astro',
+        Banner: '@/components/overrides/Banner.astro',
+      },
+      disable404Route: true,
+    }),
+    react(),
+    tailwind({
+      applyBaseStyles: false,
+    }),
+  ],
+});

docs/astro.config.mjs

@@ -0,0 +1,20 @@
+{
+  "$schema": "https://ui.shadcn.com/schema.json",
+  "style": "new-york",
+  "rsc": false,
+  "tsx": true,
+  "tailwind": {
+    "config": "tailwind.config.mjs",
+    "css": "src/styles/globals.css",
+    "baseColor": "zinc",
+    "cssVariables": true,
+    "prefix": ""
+  },
+  "aliases": {
+    "components": "@/components",
+    "utils": "@/lib/utils",
+    "ui": "@/components/ui",
+    "lib": "@/lib"
+  },
+  "iconLibrary": "lucide"
+}