refactor: Rewrite docs with VitePress

.github/workflows/ci.yaml

@@ -0,0 +1,26 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  lint-and-typecheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js 20.6.1
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20.6.1
+
+      - name: setup
+        run: npm i -g @antfu/ni
+
+      - name: install
+        run: nci
+
+      - name: lint
+        run: nr lint

.gitignore

@@ -1,12 +1,18 @@
+## User-specific files
+.DS_Store
+.idea
+
+## Vite Press related
+.vitepress/cache
+.vitepress/dist
+
 node_modules
 *.iml
-.idea
 *.log*
 .nuxt
 .vscode
-.DS_Store
 coverage
 dist
 sw.*
 .env
-.output
+.output

.vitepress/config.mts

@@ -0,0 +1,34 @@
+import { defineConfig } from 'vitepress'
+import { transformerTwoslash } from '@shikijs/vitepress-twoslash'
+import { routes as navRoutes } from './routes/navbar'
+import { routes as sidebarRoutes } from './routes/sidebar'
+
+export default defineConfig({
+  title: 'NuxtAuth',
+  titleTemplate: ':title - by sidebase',
+  description: 'The productive way to build fullstack Nuxt 3 applications.',
+  srcDir: 'src',
+  lang: 'en-US',
+  appearance: 'dark',
+  lastUpdated: true,
+  head: [['link', { rel: 'icon', href: '/favicon.ico' }]],
+  // @ts-expect-error The import types are broken?
+  markdown: { codeTransformers: [transformerTwoslash()] },
+  themeConfig: {
+    logo: '/icon.svg',
+    nav: navRoutes,
+    sidebar: sidebarRoutes,
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/sidebase' },
+      { icon: 'x', link: 'https://twitter.com/sidebase_io' },
+      { icon: 'discord', link: 'https://discord.gg/VzABbVsqAc' },
+    ],
+    footer: {
+      message: 'Released under the MIT License.',
+      copyright: 'Developed by SIDESTREAM',
+    },
+    search: {
+      provider: 'local',
+    },
+  },
+})

.vitepress/routes/navbar.ts

@@ -0,0 +1,52 @@
+import type { DefaultTheme } from 'vitepress'
+
+export const routes: DefaultTheme.Config['nav'] = [
+  {
+    text: 'Docs',
+    items: [
+      {
+        text: 'Getting started',
+        link: '/guide/getting-started/introduction',
+      },
+      {
+        text: 'Guide',
+        link: '/guide/authjs/quick-start',
+      },
+      {
+        text: 'Recipes',
+        link: '/recipes/overview',
+      },
+    ],
+  },
+  { text: 'API', link: '/api/overview' },
+  {
+    text: 'Resources',
+    items: [
+      {
+        text: 'Overview',
+        link: '/resources/overview',
+      },
+      {
+        text: 'Security',
+        link: '/resources/security',
+      },
+      {
+        text: 'Error references',
+        link: '/resources/error-reference',
+      },
+    ],
+  },
+  {
+    text: '0.8.0',
+    items: [
+      {
+        text: '0.7.2',
+        link: 'https://github.com/sidebase/nuxt-auth/tree/0.7.2/docs/content',
+      },
+      {
+        text: '0.6.7',
+        link: 'https://github.com/sidebase/nuxt-auth/tree/0.6.7/docs/content',
+      },
+    ],
+  },
+]

.vitepress/routes/sidebar.ts

@@ -0,0 +1,88 @@
+import type { DefaultTheme } from 'vitepress'
+
+export const routes: DefaultTheme.Config['sidebar'] = {
+  '/guide': [
+    {
+      text: 'Getting started',
+      base: '/guide/getting-started',
+      items: [
+        {
+          text: 'Introduction',
+          link: '/introduction',
+        },
+        {
+          text: 'Installation',
+          link: '/installation',
+        },
+        {
+          text: 'Choosing the provider',
+          link: '/choose-provider',
+        },
+      ],
+    },
+    {
+      text: 'AuthJS Provider',
+      base: '/guide/authjs',
+      items: [
+        {
+          text: 'Quick Start',
+          link: '/quick-start',
+        },
+        {
+          text: 'NuxtAuthHandler',
+          link: '/nuxt-auth-handler',
+        },
+        {
+          text: 'Custom pages',
+          link: '/custom-pages',
+        },
+        {
+          text: 'Session data',
+          link: '/session-data',
+        },
+      ],
+    },
+    {
+      text: 'Local / Refresh Provider',
+      base: '/guide/local',
+      items: [
+        {
+          text: 'Quick Start',
+          link: '/quick-start',
+        },
+        {
+          text: 'Session data',
+          link: '/session-data',
+        },
+        {
+          text: 'Refresh token',
+          link: '/refresh-token',
+        },
+      ],
+    },
+    {
+      text: 'Advanced',
+      base: '/guide/advanced',
+      items: [
+        {
+          text: 'Middleware',
+          collapsed: true,
+          items: [
+            { text: 'Global', link: '/middleware/global' },
+            { text: 'Page', link: '/middleware/page' },
+          ],
+        },
+        {
+          text: 'Deployment',
+          collapsed: true,
+          items: [
+            { text: 'Self-hosted', link: '/deployment/self-hosted' },
+            { text: 'Vercel', link: '/deployment/vercel' },
+            { text: 'Netlify', link: '/deployment/netlify' },
+          ],
+        },
+        { text: 'Caching', link: '/caching' },
+      ],
+    },
+  ],
+}

.vitepress/theme/index.ts

@@ -0,0 +1,20 @@
+// https://vitepress.dev/guide/custom-theme
+import { h } from 'vue'
+import type { EnhanceAppContext, Theme } from 'vitepress'
+import DefaultTheme from 'vitepress/theme'
+import TwoslashFloatingVue from '@shikijs/vitepress-twoslash/client'
+
+import './style.css'
+import '@shikijs/vitepress-twoslash/style.css'
+
+export default {
+  extends: DefaultTheme,
+  Layout: () => {
+    return h(DefaultTheme.Layout, null, {
+      // https://vitepress.dev/guide/extending-default-theme#layout-slots
+    })
+  },
+  enhanceApp({ app }: EnhanceAppContext) {
+    app.use(TwoslashFloatingVue)
+  },
+} satisfies Theme