docs: add vitepress for docs

tsky-dev · Nov 29, 2024 · 1f70a17 · 1f70a17
1 parent ff2e7ab
commit 1f70a17
Show file tree

Hide file tree

Showing 10 changed files with 1,910 additions and 214 deletions.
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1 @@
+.vitepress/cache/
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -0,0 +1,41 @@
+import { defineConfig } from 'vitepress'
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  title: "TSky",
+  description: "A BlueSky API client for nimble apps and tools",
+  themeConfig: {
+    // https://vitepress.dev/reference/default-theme-config
+    nav: [
+      { text: 'Home', link: '/' },
+      { text: 'Examples', link: '/examples' }
+    ],
+
+    sidebar: [
+      { text: 'Getting Started', link: '/getting-started' },
+      { text: 'API Reference', link: '/api',
+        items: [
+          { text: 'new Tsky', link: '/api#tsky' },
+          { text: 'tsky.profile', link: '/api#profile' },
+          { text: 'tsky.typeahead', link: '/api#typeahead' }
+        ],
+      },
+      {
+        text: 'Examples',
+        link: '/examples',
+      }
+    ],
+
+    search: {
+      provider: 'local'
+    },
+
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/vuejs/vitepress' }
+    ],
+
+    editLink: {
+      pattern: 'https://github.com/tsky-dev/tsky/edit/main/docs/:path',
+    }
+  }
+})
diff --git a/docs/api.md b/docs/api.md
@@ -0,0 +1,28 @@
+---
+outline: deep
+---
+
+# API Reference
+
+## Tsky
+
+### `new Tsky(app: AppBskyNS): Tsky`
+
+Create a new Tsky instance.
+
+```ts
+import { Tsky } from 'tsky'
+
+const app = new AppBskyNS(); // TODO
+const tsky = new Tsky(app);
+```
+
+### `tsky.profile(did: string): Promise<Profile>`
+
+Get a profile by DID.
+
+```ts
+const profile = await tsky.profile('did:plc:giohuovwawlijq7jkuysq5dd');
+
+console.log(profile.handle);
+```
diff --git a/docs/examples.md b/docs/examples.md
@@ -0,0 +1,7 @@
+---
+outline: deep
+---
+
+# Examples
+
+TODO: Add examples here
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -0,0 +1,25 @@
+---
+outline: deep
+---
+
+# Getting Started
+
+## Installation
+
+```bash
+$ npm add tsky
+```
+
+## Usage
+
+```ts
+import { Tsky } from 'tsky'
+
+
+const app = new AppBskyNS(); // TODO
+const tsky = new Tsky(app);
+
+const profile = await tsky.profile('did:plc:giohuovwawlijq7jkuysq5dd');
+
+console.log(profile.handle);
+```
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,31 @@
+---
+# https://vitepress.dev/reference/default-theme-home-page
+layout: home
+
+hero:
+  name: "TSky"
+  text: "A BlueSky API client for nimble apps and tools"
+  tagline: A BlueSky API client for nimble apps and tools
+  actions:
+    - theme: brand
+      text: Get Started
+      link: /getting-started
+    - theme: alt
+      text: API reference
+      link: /api
+    - theme: alt
+      text: Examples
+      link: /examples
+
+features:
+  - title: Lightweight
+    icon: 🌬️
+    details: Heavy objects will fall through the sky
+  - title: Endless possibilities
+    icon: 🌌
+    details: The sky has no limit
+  - title: Easy to use
+    icon: ☁️
+    details: Like a walk on the clouds
+---
+
diff --git a/docs/netlify.toml b/docs/netlify.toml
@@ -0,0 +1,11 @@
+[build]
+publish = "dist"
+command = "pnpm build"
+base = "/docs/"
+
+# Allow previewing docs
+[[redirects]]
+from = "/docs/*"
+to = "/:splat"
+status = 200
+force = true
diff --git a/docs/package.json b/docs/package.json
@@ -0,0 +1,15 @@
+{
+  "name": "tsky-docs",
+  "version": "1.0.0",
+  "private": true,
+  "main": "index.js",
+  "scripts": {
+    "dev": "vitepress dev",
+    "build": "vitepress build",
+    "preview": "vitepress preview",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "devDependencies": {
+    "vitepress": "^1.5.0"
+  }
+}