Skip to content

doc: update usage

doc: update usage #26

Workflow file for this run

name: doc
on:
push:
branches:
- main
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
persist-credentials: false
fetch-depth: 100
- uses: actions/setup-node@v3
with:
node-version: '20'
cache: 'pnpm'
- uses: marceloprado/has-changed-path@v1
id: changed-d-ts
with:
paths: package.json index.d.ts
- uses: pnpm/action-setup@v2
with:
version: 8
- name: Build docs
if: steps.changed-d-ts.outputs.changed == 'true'
run: |
pnpm i
pnpm build:docs
pnpm build:docs --json docs/types.json
- name: Deploy to GitHub Pages
if: steps.changed-d-ts.outputs.changed == 'true'
uses: JamesIves/[email protected]
with:
branch: gh-pages
folder: docs
single-commit: true