Skip to content

Commit

Permalink
chore: pmndrs/docs workflow (#2674)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
abernier committed Aug 15, 2024
1 parent ded02e9 commit 24542f6
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -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
Binary file added docs/favicon.ico
Binary file not shown.
Binary file added docs/logo.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 24542f6

Please sign in to comment.