Adopt Astro Starlight template for docs website (#189)

* feat: adopt astro starlight

* chore: remove website npm lockfile

* docs: fix markdown

packages/website/.gitignore

@@ -1,6 +1,7 @@
 # build output
 dist/
-.output/
+# generated types
+.astro/
 
 # dependencies
 node_modules/
@@ -11,13 +12,9 @@ yarn-debug.log*
 yarn-error.log*
 pnpm-debug.log*
 
-
 # environment variables
 .env
 .env.production
 
 # macOS-specific files
 .DS_Store
-
-# generated content
-.astro

packages/website/README.md

@@ -1,46 +1,53 @@
-# Welcome to [Astro](https://astro.build)
+# Starlight Starter Kit: Basics
 
-[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/basics)
+[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
+
+```
+npm create astro@latest -- --template starlight
+```
+
+[![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)
 
 > 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
 
 ## 🚀 Project Structure
 
-Inside of your Astro project, you'll see the following folders and files:
+Inside of your Astro + Starlight project, you'll see the following folders and files:
 
 ```
-/
+.
 ├── public/
-│   └── favicon.svg
 ├── src/
-│   ├── components/
-│   │   └── Card.astro
-│   ├── layouts/
-│   │   └── Layout.astro
-│   └── pages/
-│       └── index.astro
-└── package.json
+│   ├── assets/
+│   ├── content/
+│   │   ├── docs/
+│   │   └── config.ts
+│   └── env.d.ts
+├── astro.config.mjs
+├── package.json
+└── tsconfig.json
 ```
 
-Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
+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.
 
-There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
+Images can be added to `src/assets/` and embedded in Markdown with a relative link.
 
-Any static assets, like images, can be placed in the `public/` directory.
+Static assets, like favicons, can be placed in the `public/` directory.
 
 ## 🧞 Commands
 
 All commands are run from the root of the project, from a terminal:
 
-| Command                | Action                                             |
-| :--------------------- | :------------------------------------------------- |
-| `npm install`          | Installs dependencies                              |
-| `npm run dev`          | Starts local dev server at `localhost:3000`        |
-| `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 preview` |
-| `npm run astro --help` | Get help using the Astro CLI                       |
+| 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?
 
-Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
+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).

packages/website/astro.config.mjs

@@ -0,0 +1,24 @@
+import { defineConfig } from "astro/config";
+import starlight from "@astrojs/starlight";
+
+// https://astro.build/config
+export default defineConfig({
+  site: "https://react-awesome-reveal.morello.dev",
+  integrations: [
+    starlight({
+      title: "React Awesome Reveal",
+      social: {
+        email: "mailto:[email protected]",
+        github: "https://github.com/morellodev/react-awesome-reveal",
+        linkedin: "https://www.linkedin.com/in/dennismorello",
+        "x.com": "https://x.com/morellodev",
+      },
+      sidebar: [
+        {
+          label: "Guides",
+          autogenerate: { directory: "guides" },
+        },
+      ],
+    }),
+  ],
+});

packages/website/package.json

@@ -1,29 +1,20 @@
 {
   "name": "website",
+  "type": "module",
+  "version": "0.0.1",
   "private": true,
   "scripts": {
     "dev": "astro dev",
     "start": "astro dev",
-    "build": "astro build",
+    "build": "astro check && astro build",
     "preview": "astro preview",
-    "astro": "astro",
-    "lint": "eslint .",
-    "lint:fix": "eslint --fix ."
-  },
-  "devDependencies": {
-    "@astrojs/sitemap": "^1.2.2",
-    "@astrojs/tailwind": "^3.1.2",
-    "@fec/remark-a11y-emoji": "^3.1.0",
-    "@tailwindcss/typography": "^0.5.9",
-    "astro": "^2.3.4",
-    "eslint-plugin-tailwindcss": "^3.11.0",
-    "rehype-external-links": "^2.0.1",
-    "rehype-slug": "^5.1.0",
-    "remark-emoji": "^3.1.1",
-    "tailwindcss": "^3.3.2"
+    "astro": "astro"
   },
   "dependencies": {
-    "astro-icon": "^0.8.0",
-    "fp-ts": "^2.14.0"
+    "@astrojs/check": "^0.2.1",
+    "@astrojs/starlight": "^0.11.2",
+    "astro": "^3.2.3",
+    "sharp": "^0.32.5",
+    "typescript": "^5.2.2"
   }
 }

packages/website/public/robots.txt

@@ -1,3 +1,9 @@
+# *
 User-agent: *
 Allow: /
-Sitemap: https://react-awesome-reveal.morello.dev/sitemap-index.xml
+
+# Host
+Host: https://react-awesome-reveal.morello.dev
+
+# Sitemaps
+Sitemap: https://react-awesome-reveal.morello.dev/sitemap-index.xml