chore: pmndrs/docs workflow (#2674)

* Create docs.yml

* home_redirect

* Update docs.yml

* Add files via upload

* Update docs.yml

* Rename bear.jpg to logo.jpg

* Add files via upload

* Update docs.yml

* Update docs.yml
This commit is contained in:
Antoine BERNIER 2024-08-15 23:53:30 +02:00 committed by GitHub
parent ded02e9f66
commit 24542f6664
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 38 additions and 0 deletions

38
.github/workflows/docs.yml vendored Normal file
View File

@ -0,0 +1,38 @@
name: Build documentation and deploy to GitHub Pages
on:
push:
branches: ['main']
workflow_dispatch:
# Cancel previous run (see: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#concurrency)
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
build:
uses: pmndrs/docs/.github/workflows/build.yml@main
with:
mdx: './docs'
libname: 'Zustand'
home_redirect: '/getting-started/introduction'
icon: '/favicon.ico'
logo: '/logo.jpg'
deploy:
needs: build
runs-on: ubuntu-latest
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source
# Deploy to the github-pages environment
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- id: deployment
uses: actions/deploy-pages@v4

BIN
docs/favicon.ico Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

BIN
docs/logo.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 96 KiB