diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..ca9f3ad --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,80 @@ +name: Docs + +on: + push: + branches: + - main + - master + paths: + - 'docs/**' + - '.github/workflows/docs.yml' + pull_request: + branches: + - main + - master + paths: + - 'docs/**' + - '.github/workflows/docs.yml' + workflow_dispatch: + +concurrency: + group: docs-${{ github.ref }} + cancel-in-progress: true + +permissions: + contents: read + +jobs: + build: + name: Build VitePress docs + runs-on: ubuntu-latest + defaults: + run: + working-directory: docs + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Setup Node.js + uses: actions/setup-node@v4 + with: + node-version: 20 + cache: npm + cache-dependency-path: docs/package-lock.json + + - name: Install dependencies + run: npm ci + + - name: Build docs + env: + DOCS_BASE: ${{ github.event_name == 'pull_request' && '/' || '/SpringNote/' }} + run: npm run build + + - name: Upload Pages artifact + if: github.event_name != 'pull_request' && (github.ref_name == 'main' || github.ref_name == 'master') + uses: actions/upload-pages-artifact@v3 + with: + path: docs/.vitepress/dist + + deploy: + name: Deploy GitHub Pages + if: github.event_name != 'pull_request' && (github.ref_name == 'main' || github.ref_name == 'master') + needs: build + runs-on: ubuntu-latest + + permissions: + pages: write + id-token: write + + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + + steps: + - name: Configure Pages + uses: actions/configure-pages@v5 + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 52aa125..0da62d2 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -3,10 +3,11 @@ import { defineConfig } from 'vitepress' export default defineConfig({ title: 'SpringNote', description: 'AI-native note taking for daily work, memory, and review.', + base: process.env.DOCS_BASE || '/', cleanUrls: true, lastUpdated: true, head: [ - ['link', { rel: 'icon', href: '/images/logo.png' }], + ['link', { rel: 'icon', href: `${process.env.DOCS_BASE || '/'}images/logo.png` }], ['meta', { name: 'theme-color', content: '#16b981' }] ], locales: { diff --git a/docs/en/index.md b/docs/en/index.md index c5657bc..735c08b 100644 --- a/docs/en/index.md +++ b/docs/en/index.md @@ -13,7 +13,7 @@ hero: