feat: rewrite homepage with vitepress (#186)

Author: zoey-kaiser

.drone.yml

@@ -0,0 +1,44 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  lint:
+    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
+
+  build:
+    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: Build
+        run: nr build

.github/preview.png

@@ -0,0 +1,62 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches: [main]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Required to calculate lastUpdated
+      - name: Install pnpm
+        uses: pnpm/action-setup@v3
+        with:
+          version: 8
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: pnpm
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Install dependencies
+        run: pnpm i
+      - name: Build with VitePress
+        run: pnpm build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: .vitepress/dist
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/auto-merge.yaml

@@ -1,10 +1,15 @@
+## 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.*

.github/workflows/ci.yaml

@@ -1,2 +1,3 @@
 shamefully-hoist=true
 strict-peer-dependencies=false
+ignore-workspace-root-check=true

.github/workflows/deploy-docs.yaml

@@ -0,0 +1,41 @@
+import { defineConfig } from 'vitepress'
+import { routes as navRoutes } from './routes/navbar'
+import { routes as sidebarRoutes } from './routes/sidebar'
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  title: 'sidebase',
+  titleTemplate: ':title - by SIDESTREAM',
+  description: 'The productive way to build fullstack Nuxt 3 applications.',
+  srcDir: 'src',
+  base: '/',
+  cleanUrls: true,
+  lang: 'en-US',
+  appearance: 'dark',
+  lastUpdated: true,
+  head: [['link', { rel: 'icon', href: '/favicon.ico' }]],
+  themeConfig: {
+    logo: {
+      light: '/logo-light.svg',
+      dark: '/logo-dark.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',
+    },
+    editLink: {
+      pattern: 'https://github.com/sidebase/docs/tree/main/src/:path',
+      text: 'Edit this page on GitHub'
+    }
+  },
+})

.gitignore

@@ -0,0 +1,25 @@
+import type { DefaultTheme } from 'vitepress'
+
+export const routes: DefaultTheme.Config['nav'] = [
+  {
+    text: 'Development Kit',
+    items: [
+      {
+        text: 'Getting started',
+        link: '/sidebase/welcome',
+      },
+      {
+        text: 'Components',
+        link: '/sidebase/components',
+      },
+      {
+        text: 'Resources',
+        link: '/sidebase/resources',
+      },
+    ],
+  },
+  {
+    text: 'NuxtAuth',
+    link: 'https://auth.sidebase.io'
+  },
+]

.npmrc

@@ -0,0 +1,88 @@
+import type { DefaultTheme } from 'vitepress'
+
+export const routes: DefaultTheme.Config['sidebar'] = {
+  '/sidebase': [
+    {
+      text: 'Welcome',
+      base: '/sidebase/welcome',
+      items: [
+        {
+          text: 'Introduction',
+          link: '/',
+        },
+        {
+          text: 'Stacks',
+          link: '/stacks',
+        },
+        {
+          text: 'Quick Start',
+          link: '/quick-start',
+        },
+        {
+          text: 'Getting Help',
+          link: '/getting-help',
+        },
+        {
+          text: 'FAQ',
+          link: '/faq',
+        },
+      ],
+    },
+    {
+      text: 'Components',
+      base: '/sidebase/components',
+      items: [
+        {
+          text: 'Overview',
+          link: '/',
+        },
+        {
+          text: 'Nuxt 3',
+          link: '/nuxt-3',
+        },
+        {
+          text: 'Typescript',
+          link: '/typescript',
+        },
+        {
+          text: 'Prisma ORM',
+          link: '/prisma',
+        },
+        {
+          text: 'tRPC',
+          link: '/trpc',
+        },
+        {
+          text: 'Nuxt Auth',
+          link: '/nuxt-auth',
+        },
+        {
+          text: 'Tailwind CSS',
+          link: '/tailwindcss',
+        },
+      ],
+    },
+    {
+      text: 'Resources',
+      base: '/sidebase/resources',
+      items: [
+        {
+          text: 'Overview',
+          link: '/',
+        },
+        {
+          text: 'Coding Setup',
+          link: '/coding-setup',
+        },
+        {
+          text: 'Breakpoint Debugging',
+          link: '/breakpoint-debugging',
+        },
+        {
+          text: 'Commands Cheat sheet',
+          link: '/commands',
+        },
+      ],
+    },
+  ],
+}