Update docs

.github/workflows/gh-pages.yml

@@ -1,34 +1,66 @@
-name: github pages
+# Sample workflow for building and deploying a VitePress site to GitHub Pages
+#
+name: Deploy VitePress site to Pages
 
 on:
+  # Runs on pushes targeting the `main` branch. Change this to `master` if you're
+  # using the `master` branch as the default branch.
   push:
-    branches:
-      - main  # Set a branch to deploy
+    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:
-  deploy:
-    runs-on: ubuntu-20.04
+  # Build job
+  build:
+    runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - name: Checkout
+        uses: actions/checkout@v3
         with:
-          submodules: true  # Fetch Hugo themes (true OR recursive)
-          fetch-depth: 0    # Fetch all history for .GitInfo and .Lastmod
-
-      - name: Setup Hugo
-        uses: peaceiris/actions-hugo@v2
+          fetch-depth: 0 # Not needed if lastUpdated is not enabled
+      # - uses: pnpm/action-setup@v2 # Uncomment this if you're using pnpm
+      # - uses: oven-sh/setup-bun@v1 # Uncomment this if you're using Bun
+      - name: Setup Node
+        uses: actions/setup-node@v3
         with:
-          hugo-version: 'latest'
-          extended: true
-
-      - name: Update theme
-        run: git submodule update --init --recursive
-
-      - name: Build
-        run: hugo --minify
-
-      - name: Deploy
-        uses: peaceiris/actions-gh-pages@v3
-        if: github.ref == 'refs/heads/main'
+          node-version: 18
+          cache: npm # or pnpm / yarn
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Install dependencies
+        run: npm ci # or pnpm install / yarn install / bun install
+      - name: Build with VitePress
+        run: |
+          npm run docs:build
+          touch .vitepress/dist/.nojekyll
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
         with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./public
+          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@v2

.gitignore

@@ -1,7 +1,17 @@
-.vuepress/dist
-.vitepress/dist
-.vite/*
-node_modules/*
-.hugo_build.lock
-public/*
-resources/_gen/*
+/coverage
+/src/client/shared.ts
+/src/node/shared.ts
+*.log
+*.tgz
+.DS_Store
+.idea
+.temp
+.vite_opt_cache
+.vscode
+dist
+cache
+temp
+examples-temp
+node_modules
+pnpm-global
+TODOs.md

.vitepress/config.mjs

@@ -0,0 +1,74 @@
+import { defineConfig } from 'vitepress'
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  lang: 'en-US',
+  title: "Pixelfed Docs",
+  base: "/",
+  description: "The official Pixelfed documentation",
+  themeConfig: {
+    logo: {
+      light: '/logo-black.png',
+      dark: '/logo-white.png'
+    },
+
+    siteTitle: 'Docs',
+
+    // https://vitepress.dev/reference/default-theme-config
+    nav: [
+      { text: 'pixelfed.org', link: 'https://pixelfed.org' },
+      { text: 'Support', link: 'https://github.com/pixelfed/pixelfed/discussions' },
+    ],
+
+    search: {
+      provider: 'local'
+    },
+
+    i18nRouting: false,
+
+    sidebar: [
+      {
+        text: 'Running Pixelfed',
+        items: [
+          { text: 'Prerequisites', link: '/running-pixelfed/prerequisites' },
+          { text: 'Installation', link: '/running-pixelfed/installation' },
+          { text: 'Configuration', link: '/running-pixelfed/configuration' },
+          { text: 'Administration', link: '/running-pixelfed/administration' },
+          { text: 'CLI Cheatsheet', link: '/running-pixelfed/cli-cheatsheet' },
+          { text: 'Troubleshooting', link: '/running-pixelfed/troubleshooting' }
+        ]
+      },
+      {
+        text: 'Spec Compliance',
+        items: [
+          { text: 'ActivityPub', link: '/spec/ActivityPub' },
+        ]
+      },
+    ],
+
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/pixelfed' },
+      { icon: 'discord', link: 'https://discord.gg/MHvDHaSzmc' },
+      { 
+        icon: {
+          svg: '<svg width="20" height="20" version="1.1" id="svg161" xmlns="http://www.w3.org/2000/svg" xmlns:svg="http://www.w3.org/2000/svg"> <defs id="defs165" /> <path d="M 10,20 C 4.4772,20 0,15.5228 0,10 0,4.4772 4.4772,0 10,0 15.5228,0 20,4.4772 20,10 20,15.5228 15.5228,20 10,20 Z M 9.206,12.1832 h 1.8344 c 1.728,0 3.1292,-1.364 3.1292,-3.046 0,-1.6824 -1.4008,-3.0464 -3.1292,-3.0464 H 8.3928 c -0.9968,0 -1.8052,0.7868 -1.8052,1.7576 v 6.84 z" fill-rule="evenodd" id="path159" style="stroke-width:0.4" /></svg>'
+        }, 
+        link: 'https://pixelfed.social/@pixelfed' 
+      },
+      { icon: 'mastodon', link: 'https://mastodon.social/@pixelfed' },
+    ]
+  },
+  locales: {
+    root: {
+      label: 'English',
+      lang: 'en'
+    },
+  },
+  head: [
+    ['link', { rel: "apple-touch-icon", sizes: "180x180", href: "/assets/favicon.png"}],
+    ['link', { rel: "icon", type: "image/png", sizes: "32x32", href: "/assets/favicon.png"}],
+    ['link', { rel: "icon", type: "image/png", sizes: "16x16", href: "/assets/favicon.png"}],
+    ['link', { rel: "shortcut icon", href: "/assets/favicon.png"}],
+    ['meta', { name: "theme-color", content: "#ffffff"}],
+  ],
+})