docs: rewrite docs from raw markdown to astro+starlight static website

MatthewWid · Oct 25, 2024 · 00dc167 · 00dc167
1 parent 61adebd
commit 00dc167
Show file tree

Hide file tree

Showing 20 changed files with 5,712 additions and 320 deletions.
diff --git a/docs/.gitignore b/docs/.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
diff --git a/docs/README.md b/docs/README.md
diff --git a/docs/astro.config.ts b/docs/astro.config.ts
@@ -0,0 +1,25 @@
+import {defineConfig} from "astro/config";
+import starlight from "@astrojs/starlight";
+
+export default defineConfig({
+	site: "https://matthewwid.github.io",
+	integrations: [
+		starlight({
+			title: "Better SSE",
+			social: {
+				github: "https://github.com/MatthewWid/better-sse",
+			},
+			sidebar: [
+				{
+					label: "Guides",
+					autogenerate: {directory: "guides"},
+				},
+				{
+					label: "Reference",
+					autogenerate: {directory: "reference"},
+				},
+			],
+			customCss: ["./src/styles/custom.css"],
+		}),
+	],
+});
diff --git a/docs/comparison.md b/docs/comparison.md
diff --git a/docs/getting-started.md b/docs/getting-started.md
diff --git a/docs/package.json b/docs/package.json
@@ -0,0 +1,19 @@
+{
+	"name": "better-sse-docs",
+	"version": "0.1.0",
+	"type": "module",
+	"scripts": {
+		"dev": "astro dev",
+		"start": "astro dev",
+		"build": "astro check && astro build",
+		"preview": "astro preview",
+		"astro": "astro"
+	},
+	"dependencies": {
+		"@astrojs/check": "^0.9.4",
+		"@astrojs/starlight": "^0.28.3",
+		"astro": "^4.16.7",
+		"sharp": "^0.32.6",
+		"typescript": "^5.6.3"
+	}
+}