Skip to content

Commit 24542f6

Browse files
authored
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
1 parent ded02e9 commit 24542f6

File tree

3 files changed

+38
-0
lines changed

3 files changed

+38
-0
lines changed

.github/workflows/docs.yml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Build documentation and deploy to GitHub Pages
2+
on:
3+
push:
4+
branches: ['main']
5+
workflow_dispatch:
6+
7+
# Cancel previous run (see: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#concurrency)
8+
concurrency:
9+
group: ${{ github.workflow }}-${{ github.ref }}
10+
cancel-in-progress: true
11+
12+
jobs:
13+
build:
14+
uses: pmndrs/docs/.github/workflows/build.yml@main
15+
with:
16+
mdx: './docs'
17+
libname: 'Zustand'
18+
home_redirect: '/getting-started/introduction'
19+
icon: '/favicon.ico'
20+
logo: '/logo.jpg'
21+
22+
deploy:
23+
needs: build
24+
runs-on: ubuntu-latest
25+
26+
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
27+
permissions:
28+
pages: write # to deploy to Pages
29+
id-token: write # to verify the deployment originates from an appropriate source
30+
31+
# Deploy to the github-pages environment
32+
environment:
33+
name: github-pages
34+
url: ${{ steps.deployment.outputs.page_url }}
35+
36+
steps:
37+
- id: deployment
38+
uses: actions/deploy-pages@v4

docs/favicon.ico

18.7 KB
Binary file not shown.

docs/logo.jpg

95.6 KB
Loading

0 commit comments

Comments
 (0)