Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
c121914yu committed Aug 23, 2023
1 parent a3c4a85 commit f8fc538
Show file tree
Hide file tree
Showing 6 changed files with 143 additions and 15 deletions.
70 changes: 70 additions & 0 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
@@ -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
6 changes: 6 additions & 0 deletions docSite/README.md
Original file line number Diff line number Diff line change
@@ -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
4 changes: 2 additions & 2 deletions docSite/assets/jsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
"baseUrl": ".",
"paths": {
"*": [
"../../../../../Library/Caches/hugo_cache/modules/filecache/modules/pkg/mod/github.com/gohugoio/hugo-mod-jslibs-dist/popperjs/[email protected]/package/dist/cjs/popper.js/*",
"../../../../../Library/Caches/hugo_cache/modules/filecache/modules/pkg/mod/github.com/twbs/[email protected]+incompatible/js/*"
"../../../../../.cache/hugo_cache/modules/filecache/modules/pkg/mod/github.com/gohugoio/hugo-mod-jslibs-dist/popperjs/[email protected]/package/dist/cjs/popper.js/*",
"../../../../../.cache/hugo_cache/modules/filecache/modules/pkg/mod/github.com/twbs/[email protected]+incompatible/js/*"
]
}
}
Expand Down
24 changes: 12 additions & 12 deletions docSite/content/docs/intro.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "快速了解 FastGPT"
description: "FastGPT 的能力与优势"
icon: "rocket_launch"
title: '快速了解 FastGPT'
description: 'FastGPT 的能力与优势'
icon: 'rocket_launch'
draft: false
toc: true
weight: -100
Expand All @@ -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) |

Expand Down Expand Up @@ -53,29 +53,29 @@ FastGPT 对外的 API 接口对齐了 OpenAI 官方接口,可以直接接入
## FastGPT 特点

1. **项目完全开源**

FastGPT 遵循 Apache License 2.0 开源协议,你可以 [Fork](https://github.com/labring/FastGPT/fork) 之后进行二次开发和发布。FastGPT 社区版将保留核心功能,商业版仅在社区版基础上使用 API 的形式进行扩展,不影响学习使用。

2. **独特的 QA 结构**

针对客服问答场景设计的 QA 结构,提高在大量数据场景中的问答准确性。

3. **可视化工作流**

通过 Flow 模块展示了从问题输入到模型输出的完整流程,便于调试和设计复杂流程。

4. **无限扩展**

基于 API 进行扩展,无需修改 FastGPT 源码,也可快速接入现有的程序中。

5. **便于调试**

提供搜索测试、引用修改、完整对话预览等多种调试途径。

6. **支持多种模型**

支持 GPT、Claude、文心一言等多种 LLM 模型,未来也将支持自定义的向量模型。

## 知识库核心流程图

![](/imgs/KBProcess.jpg)
![](/imgs/KBProcess.jpg)
2 changes: 1 addition & 1 deletion docSite/go.mod
Original file line number Diff line number Diff line change
@@ -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
Expand Down
52 changes: 52 additions & 0 deletions docSite/vercel.json
Original file line number Diff line number Diff line change
@@ -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
}
}

0 comments on commit f8fc538

Please sign in to comment.