docs

.github/workflows/deploy-docs.yml

@@ -0,0 +1,70 @@
+# Workflow to build and deploy site to Vercel using Hugo
+
+# Name of Workflow
+name: deploy-production
+
+# Controls when the action will run. Triggers the workflow on push
+# events but only for the vercel branch
+on:
+  push:
+    branches: [docs]
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains jobs "deploy-production"
+  deploy-production:
+    # The environment this job references
+    environment:
+      name: Production
+      url: ${{ steps.vercel-action.outputs.preview-url }}
+
+    # The type of runner that the job will run on
+    runs-on: ubuntu-22.04
+
+    # Job outputs
+    outputs:
+      docs: ${{ steps.filter.outputs.docs }}
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Step 1 - Checks-out your repository under $GITHUB_WORKSPACE
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          submodules: recursive # Fetch submodules
+          fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod
+
+      # Step 2 Detect changes to Docs Content
+      - name: Detect changes in doc content
+        uses: dorny/paths-filter@v2
+        id: filter
+        with:
+          filters: |
+            docs:
+              - 'docSite/content/docs/**'
+          base: main
+
+      # Step 3 - Install Hugo (specific version)
+      - name: Install Hugo
+        uses: peaceiris/actions-hugo@v2
+        with:
+          hugo-version: '0.117.0'
+          extended: true
+
+      # Step 4 - Builds the site using Hugo
+      - name: Build
+        run: hugo -v --minify -s docSite
+        env:
+          HUGO_BASEURL: ${{ vars.BASE_URL }}
+
+      # Step 5 - Push our generated site to Vercel
+      - name: Deploy to Vercel
+        uses: amondnet/vercel-action@v25
+        id: vercel-action
+        with:
+          vercel-token: ${{ secrets.VERCEL_TOKEN }} # Required
+          vercel-org-id: ${{ secrets.VERCEL_ORG_ID }} #Required
+          vercel-project-id: ${{ secrets.VERCEL_PROJECT_ID }} #Required
+          github-comment: false
+          vercel-args: '--prod --local-config ../vercel.json' # Optional
+          working-directory: docSite/public

docSite/README.md

@@ -1,3 +1,9 @@
 # 文档
 
 ## 本地运行
+
+1. 安装 go 语言环境。
+2. 安装 hugo。 [二进制下载](https://github.com/gohugoio/hugo/releases/tag/v0.117.0)
+3. cd docSite
+4. hugo serve
+5. 访问 http://localhost:1313

docSite/assets/jsconfig.json

@@ -3,8 +3,8 @@
   "baseUrl": ".",
   "paths": {
    "*": [
-    "../../../../../Library/Caches/hugo_cache/modules/filecache/modules/pkg/mod/github.com/gohugoio/hugo-mod-jslibs-dist/popperjs/v2@v2.21100.20000/package/dist/cjs/popper.js/*",
+    "../../../../../.cache/hugo_cache/modules/filecache/modules/pkg/mod/github.com/gohugoio/hugo-mod-jslibs-dist/popperjs/v2@v2.21100.20000/package/dist/cjs/popper.js/*",
-    "../../../../../Library/Caches/hugo_cache/modules/filecache/modules/pkg/mod/github.com/twbs/bootstrap@v5.3.0+incompatible/js/*"
+    "../../../../../.cache/hugo_cache/modules/filecache/modules/pkg/mod/github.com/twbs/bootstrap@v5.3.0+incompatible/js/*"
    ]
   }
  }

docSite/content/docs/intro.md

@@ -1,7 +1,7 @@
 ---
-title: "快速了解 FastGPT"
+title: '快速了解 FastGPT'
-description: "FastGPT 的能力与优势"
+description: 'FastGPT 的能力与优势'
-icon: "rocket_launch"
+icon: 'rocket_launch'
 draft: false
 toc: true
 weight: -100
@@ -13,8 +13,8 @@ FastGPT 是一个基于 LLM 大语言模型的知识库问答系统，提供开
 FastGPT 在线体验：[https://fastgpt.run](https://fastgpt.run)
 {{% /alert %}}
 
-|                            |                            |
+|                       |                       |
-| -------------------------- | -------------------------- |
+| --------------------- | --------------------- |
 | ![](/imgs/intro1.png) | ![](/imgs/intro2.png) |
 | ![](/imgs/intro3.png) | ![](/imgs/intro4.png) |
 

docSite/go.mod

@@ -1,6 +1,6 @@
 module fastgpt-docs
 
-go 1.21.0
+go 1.23
 
 require (
 	github.com/colinwilson/lotusdocs v0.0.0-20230821033552-c5bcbdd9df80 // indirect

docSite/vercel.json

@@ -0,0 +1,52 @@
+{
+  "redirects": [
+    {
+      "source": "/",
+      "destination": "/docs"
+    },
+    {
+      "source": "/imgs/:path*",
+      "destination": "https://cdn.jsdelivr.us/gh/yangchuansheng/FastGPT@main/docSite/assets/imgs/:path*"
+    }
+  ],
+  "headers": [
+    {
+      "source": "/(.*)",
+      "headers": [
+        {
+          "key": "X-Content-Type-Options",
+          "value": "nosniff"
+        },
+        {
+          "key": "X-Frame-Options",
+          "value": "SAMEORIGIN"
+        },
+        {
+          "key": "X-XSS-Protection",
+          "value": "1; mode=block"
+        },
+        {
+          "key": "Referrer-Policy",
+          "value": "strict-origin"
+        },
+        {
+          "key": "Permissions-Policy",
+          "value": "geolocation=(self), microphone=()"
+        }
+      ]
+    },
+    {
+      "source": "/docs/fonts/:all*(woff2)",
+      "headers": [
+        {
+          "key": "Cache-Control",
+          "value": "public, max-age=31536000, immutable"
+        }
+      ]
+    }
+  ],
+  "trailingSlash": true,
+  "github": {
+    "enabled": false
+  }
+}