docs with vitepress and github pages

Author: shakiba

.github/workflows/deploy-docs.yml

@@ -0,0 +1,50 @@
+name: Deploy docs to github pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["vitepress"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets the GITHUB_TOKEN permissions to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+      - name: Set up Node
+        uses: actions/setup-node@v6
+        with:
+          node-version: lts/*
+          cache: "npm"
+      - name: Install dependencies
+        run: npm install
+      - name: Build
+        run: npm run typedoc && npm run docs:build
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v4
+        with:
+          # Upload dist folder
+          path: "./dist"
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -1,6 +1,9 @@
 # build
 dist/
 
+# typedoc
+docs/pages/api/
+
 # misc
 .DS_Store
 *.pem
@@ -41,3 +44,8 @@ docs/dist/*
 # typescript
 *.tsbuildinfo
 next-env.d.ts
+
+# VitePress
+docs/.vitepress/cache/
+docs/.vitepress/dist/
+docs/.vitepress/.temp/

docs/.vitepress/config.ts

@@ -0,0 +1,71 @@
+import { defineConfig } from "vitepress";
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  title: "Stage.js Docs",
+  description: "2D JavaScript library for cross-platform HTML5 game development",
+  srcDir: "./pages",
+  base: "/stage.js/docs/",
+  outDir: "../dist/docs",
+  themeConfig: {
+    // https://vitepress.dev/reference/default-theme-config
+    search: {
+      provider: "local",
+    },
+    // nav: [
+    // { text: "GitHub", link: "https://github.com/piqnt/stage.js" },
+    // { text: "Discord", link: "https://discord.gg/7B5e7MXFxQ" },
+    // ],
+    socialLinks: [
+      { icon: "github", link: "https://github.com/piqnt/stage.js" },
+      { icon: "discord", link: "https://discord.gg/7B5e7MXFxQ" },
+    ],
+    sidebar: [
+      {
+        text: "Getting Started",
+        collapsed: true,
+        items: [
+          { text: "Introduction", link: "/" },
+          { text: "Install", link: "/install" },
+          { text: "Hello World", link: "/hello-world" },
+        ],
+      },
+      {
+        text: "Core",
+        collapsed: true,
+        items: [
+          { text: "Setup", link: "/setup" },
+          { text: "Game Loop", link: "/loop" },
+          { text: "Events and Pointer", link: "/events" },
+        ],
+      },
+      {
+        text: "Texture",
+        collapsed: true,
+        items: [
+          { text: "Texture", link: "/texture" },
+          { text: "Atlas", link: "/atlas" },
+          { text: "Sprite Component", link: "/sprite" },
+          { text: "Anim Component", link: "/anim" },
+          { text: "Monotype Component", link: "/monotype" },
+        ],
+      },
+      {
+        text: "Layout",
+        collapsed: true,
+        items: [
+          { text: "Component Tree", link: "/tree" },
+          { text: "Pin", link: "/pin" },
+          { text: "Transition", link: "/transition" },
+          { text: "Layout Components", link: "/layout" },
+        ],
+      },
+      { text: "API Reference", link: "/api/" },
+      {
+        text: "What's new?",
+        collapsed: false,
+        items: [{ text: "v1.0 - Work in Progress", link: "/news/v1.0" }],
+      },
+    ],
+  },
+});