Skip to content

Update README.md

Update README.md #770

Workflow file for this run

name: Deploy Docs
on:
push:
branches:
- main
jobs:
deploy-gh-pages:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Install pnpm
uses: pnpm/action-setup@v2
with:
run_install: true
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 20
cache: pnpm
- name: Build Docs
env:
NODE_OPTIONS: --max_old_space_size=4096
run: pnpm run docs:build
- name: Deploy Docs
uses: JamesIves/github-pages-deploy-action@v4
with:
# This is the branch where the docs are deployed to
branch: gh-pages
clean: true
folder: docs/.vuepress/dist
- name: 📂 Sync files
uses: SamKirkland/[email protected]
with:
server: ${{ secrets.ftp_server }}
username: ${{ secrets.ftp_username }}
password: ${{ secrets.ftp_password }}
local-dir: docs/.vuepress/dist/
port: 168