Merge pull request #8 from fostertheweb/astro-docs

Add Documentation Website

.changeset/config.json

@@ -3,7 +3,7 @@
   "changelog": ["@changesets/changelog-github", { "repo": "fostertheweb/spotify-web-sdk" }],
   "commit": false,
   "fixed": [],
-  "linked": [],
+  "linked": [["@fostertheweb/spotify-web-sdk", "docs"]],
   "access": "public",
   "baseBranch": "main",
   "updateInternalDependencies": "patch",

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

docs/.vscode/extensions.json

@@ -0,0 +1,4 @@
+{
+  "recommendations": ["astro-build.astro-vscode"],
+  "unwantedRecommendations": []
+}

docs/.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "./node_modules/.bin/astro dev",
+      "name": "Development server",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
+}

docs/README.md

@@ -0,0 +1,54 @@
+# Starlight Starter Kit: 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)
+[![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)
+
+> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
+
+## 🚀 Project Structure
+
+Inside of your Astro + Starlight project, you'll see the following folders and files:
+
+```
+.
+├── public/
+├── src/
+│   ├── assets/
+│   ├── content/
+│   │   ├── docs/
+│   │   └── config.ts
+│   └── env.d.ts
+├── astro.config.mjs
+├── package.json
+└── tsconfig.json
+```
+
+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.
+
+Images can be added to `src/assets/` and embedded in Markdown with a relative link.
+
+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: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?
+
+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/astro.config.mjs

@@ -0,0 +1,41 @@
+import starlight from "@astrojs/starlight";
+import { defineConfig } from "astro/config";
+import { generateTypeDoc } from "starlight-typedoc";
+
+const typeDocSidebarGroup = await generateTypeDoc({
+  entryPoints: ["../src/index.ts"],
+  tsconfig: ["../tsconfig.json"],
+});
+
+// https://astro.build/config
+export default defineConfig({
+  integrations: [
+    starlight({
+      title: "Spotify Web SDK",
+      components: {
+        Hero: "./src/components/Hero.astro",
+      },
+      customCss: ["./src/styles/custom.css"],
+      social: {
+        github: "https://github.com/fostertheweb/spotify-web-sdk",
+      },
+      sidebar: [
+        {
+          label: "Guides",
+          items: [
+            { label: "Getting Started", link: "/guides/quickstart" },
+            { label: "Authentication", link: "/guides/authentication" },
+            {
+              label: "Extensibility",
+              link: "/guides/exstensibility",
+            },
+          ],
+        },
+        {
+          ...typeDocSidebarGroup,
+          label: "Reference",
+        },
+      ],
+    }),
+  ],
+});

docs/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "docs",
+  "type": "module",
+  "version": "1.2.1",
+  "private": true,
+  "scripts": {
+    "dev": "astro dev",
+    "start": "astro dev",
+    "build": "astro check && astro build",
+    "preview": "astro preview",
+    "astro": "astro",
+    "upgrade": "pnpm dlx @astrojs/upgrade"
+  },
+  "dependencies": {
+    "@astrojs/starlight": "^0.15.1",
+    "astro": "^4.0.6",
+    "sharp": "^0.32.5",
+    "starlight-typedoc": "^0.6.0",
+    "typedoc": "^0.25.4",
+    "typedoc-plugin-markdown": "4.0.0-next.36"
+  }
+}