feat(docs): site migration (#1781)

Author: felangel

.github/actions/astro_site/action.yaml

@@ -0,0 +1,36 @@
+name: Astro Site Workflow
+description: Build and test Astro sites.
+
+inputs:
+  working_directory:
+    required: false
+    default: "."
+    description: The working directory for this workflow
+  node_version:
+    required: false
+    default: "22"
+    description: The node version to use.
+
+runs:
+  using: "composite"
+  steps:
+    - name: ⚙️ Setup Node
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ inputs.node_version }}
+
+    - name: ⬇️ Install Dependencies
+      run: npm install
+      shell: ${{ inputs.shell }}
+      working-directory: ${{ inputs.working_directory }}
+
+    - name: ✨ Check Format
+      run: npm run format:check
+      shell: ${{ inputs.shell }}
+      working-directory: ${{ inputs.working_directory }}
+
+    - name: 📦 Build Site
+      uses: withastro/action@v2
+      with:
+        path: ${{ inputs.working_directory }}
+        node-version: ${{ inputs.node_version }}

.github/workflows/docs.yaml

@@ -1,38 +1,48 @@
 name: docs
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 on:
   pull_request:
     paths:
       - ".github/workflows/docs.yaml"
       - "docs/**"
+  push:
+    branches: [main]
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
 
 jobs:
   build:
     runs-on: ubuntu-latest
 
-    defaults:
-      run:
-        working-directory: docs
+    name: 🌐 Site Build
 
     steps:
       - name: 📚 Git Checkout
         uses: actions/checkout@v4
 
-      - name: ⚙️ Setup Node
-        uses: actions/setup-node@v4
+      - name: 📦 Build Site
+        uses: ./.github/actions/astro_site
         with:
-          node-version: 18.x
-          cache: yarn
-          cache-dependency-path: docs/yarn.lock
+          working_directory: ./docs
 
-      - name: 📦 Install Dependencies
-        run: yarn install --frozen-lockfile
+  deploy:
+    needs: build
+    if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
 
-      - name: ✨ Check Format
-        run: yarn run format:check
+    runs-on: ubuntu-latest
 
-      - name: 🧹 Lint
-        run: yarn run lint
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
 
-      - name: 👷 Build website
-        run: yarn build
+    steps:
+      - name: 🚀 Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

docs/.eslintrc.js

@@ -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,5 +1 @@
-node_modules
-/build
-/public/build
-.env
-.docusaurus
+src/components/**/*.mdx

docs/.prettierignore

@@ -1,3 +1,13 @@
 {
-  "singleQuote": true
+  "printWidth": 100,
+  "semi": true,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "trailingComma": "es5",
+  "useTabs": true,
+  "plugins": ["prettier-plugin-astro"],
+  "overrides": [
+    { "files": [".*", "*.json", "*.md", "*.toml", "*.yml"], "options": { "useTabs": false } },
+    { "files": ["*.md", "*.mdx"], "options": { "printWidth": 80, "proseWrap": "always" } }
+  ]
 }

docs/.prettierrc

@@ -1,25 +1,24 @@
-# 📚 Dart Frog Site
+# Dart Frog Site 📚
 
-This website is built using [Docusaurus 3](https://docusaurus.io/), a modern static website generator.
+[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
 
-### ⚙️ Installation
+Home of the [dart-frog.dev](https://dart-frog.dev) site.
 
-```
-yarn install
-```
+## 🧞 Commands
 
-### 🧑‍💻 Local Development
+All commands are run from the root of the project, from a terminal:
 
-```
-yarn start
-```
+| 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                     |
 
-This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+## 👀 Want to learn more?
 
-### 📦 Build
-
-```
-yarn build
-```
-
-This command generates static content into the `build` directory and can be served using any static contents hosting service.
+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,90 @@
+// @ts-check
+import { defineConfig } from 'astro/config';
+import starlight from '@astrojs/starlight';
+import tailwindcss from '@tailwindcss/vite';
+import starlightLinksValidator from 'starlight-links-validator';
+
+const site = 'https://dart-frog.dev/';
+
+// https://astro.build/config
+export default defineConfig({
+	site,
+	integrations: [
+		starlight({
+			title: 'Dart Frog',
+			tagline: 'A fast, minimalistic backend framework for Dart 🎯',
+			logo: {
+				light: './src/assets/logo-dark.png',
+				dark: './src/assets/logo-light.png',
+				replacesTitle: true,
+			},
+			favicon: 'favicon.ico',
+			expressiveCode: {
+				themes: ['dark-plus', 'github-light'],
+			},
+			social: [
+				{
+					icon: 'github',
+					label: 'GitHub',
+					href: 'https://github.com/dart-frog-dev/dart_frog',
+				},
+				{
+					icon: 'discord',
+					label: 'Discord',
+					href: 'https://discord.gg/dart-frog',
+				},
+			],
+			editLink: {
+				baseUrl: 'https://github.com/dart-frog-dev/dart_frog/edit/main/docs',
+			},
+			head: [
+				{
+					tag: 'meta',
+					attrs: { property: 'og:image', content: site + 'open-graph.png?v=1' },
+				},
+				{
+					tag: 'meta',
+					attrs: {
+						property: 'twitter:image',
+						content: site + 'open-graph.png?v=1',
+					},
+				},
+			],
+			customCss: ['./src/tailwind.css', './src/styles/landing.css'],
+			sidebar: [
+				{
+					label: 'Getting Started',
+					link: '/getting-started/',
+				},
+				{
+					label: 'Basics',
+					autogenerate: { directory: 'basics' },
+				},
+				{
+					label: 'Tutorials',
+					autogenerate: { directory: 'tutorials' },
+				},
+				{
+					label: 'Deploy',
+					autogenerate: { directory: 'deploy' },
+				},
+				{
+					label: 'Advanced',
+					autogenerate: { directory: 'advanced' },
+				},
+				{
+					label: '🗺️ Roadmap',
+					link: '/roadmap/',
+				},
+			],
+			plugins: [
+				starlightLinksValidator({
+					errorOnFallbackPages: false,
+					errorOnInconsistentLocale: true,
+					exclude: ['http://localhost:8080', 'http://localhost:8080/**'],
+				}),
+			],
+		}),
+	],
+	vite: { plugins: [tailwindcss()] },
+});