diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..cea850e --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,65 @@ +on: + # Runs on pushes targeting the `main` branch. Change this to `master` if you're + # using the `master` branch as the default branch. + push: + branches: [main] + paths: + - 'docs/**' + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: pages + cancel-in-progress: false + +jobs: + # Build job + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v3 + with: + fetch-depth: 0 # Not needed if lastUpdated is not enabled + # - uses: pnpm/action-setup@v2 # Uncomment this if you're using pnpm + # - uses: oven-sh/setup-bun@v1 # Uncomment this if you're using Bun + - uses: pnpm/action-setup@v2 + with: + version: 8 + - name: Setup Node + uses: actions/setup-node@v3 + with: + node-version: 20 + cache: pnpm # or pnpm / yarn + - name: Setup Pages + uses: actions/configure-pages@v3 + - name: Install dependencies + run: pnpm i # or pnpm install / yarn install / bun install + - name: Build + run: | + pnpm docs:build + - name: Upload artifact + uses: actions/upload-pages-artifact@v2 + with: + path: docs/.vitepress/dist + + # Deployment job + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + needs: build + runs-on: ubuntu-latest + name: Deploy + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v2 diff --git a/docs/index.md b/docs/index.md index 546de8f..c7b562b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,21 @@ -# Secure Browse +--- +layout: home +title: Secure Browse + +hero: + name: Secure Browse + text: Extension Manager for Financial Sites + image: + src: ./assets/disable.png + alt: Secure Browse + actions: + - theme: brand + text: Install Extension + link: https://github.com/rxliuli/secure-browse/releases/latest + - theme: alt + text: Star on GitHub + link: https://github.com/rxliuli/secure-browse +--- ## Overview