diff --git a/.github/workflows/doc-build.yml b/.github/workflows/doc-build.yml new file mode 100644 index 000000000..857819e72 --- /dev/null +++ b/.github/workflows/doc-build.yml @@ -0,0 +1,38 @@ +name: Deploy to GitHub Pages + +on: + push: + branches: + - 'doc-build' + schedule: + - cron: '0 15 * * *' + +jobs: + deploy: + name: Deploy to GitHub Pages + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + with: + ref: doc-build + - uses: actions/setup-node@v3 + with: + node-version: 18 + cache: npm + - name: Set Up Golang Environment + uses: actions/setup-go@v4 + with: + go-version: 1.20.4 + cache: false + - name: download goframe docs + run: ./download.sh + - name: Install dependencies + run: npm ci + - name: Build website + run: npm run build + - name: Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./build + cname: pages.goframe.org diff --git a/README.MD b/README.MD index a81c2eb35..ab6536be6 100644 --- a/README.MD +++ b/README.MD @@ -62,7 +62,8 @@ golang version >= 1.18 # Documentation - Chinese Official Site(中文官网): [https://goframe.org](https://goframe.org/display/gf) -- Offline Document(中文离线文档): [https://github.com/gogf/goframe.org-pdf](https://github.com/gogf/goframe.org-pdf) +- Chinese Pages Document(中文镜像文档): [https://pages.goframe.org](https://pages.goframe.org) +- Chinese Offline Document(中文离线文档): [https://github.com/gogf/goframe.org-pdf](https://github.com/gogf/goframe.org-pdf) - GoDoc API: [https://pkg.go.dev/github.com/gogf/gf/v2](https://pkg.go.dev/github.com/gogf/gf/v2) # License