Skip to content

Commit

Permalink
docs: add open api docs and generator (#12)
Browse files Browse the repository at this point in the history
* docs: add open api docs and generator

* chore: update lockfile

* style: prettier
  • Loading branch information
alvarogfn authored Apr 27, 2024
1 parent fbcff97 commit 69dc739
Show file tree
Hide file tree
Showing 11 changed files with 7,554 additions and 1,268 deletions.
30 changes: 30 additions & 0 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: GitHub Pages

on:
push:
branches:
- main

jobs:
deploy:
runs-on: ubuntu-22.04
permissions:
contents: write
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
steps:
- name: Code Checkout
uses: actions/checkout@v3

- name: Setup deps
uses: ./.github/actions/install-deps

- name: Build
run: pnpm run build:docs

- name: Deploy
uses: peaceiris/actions-gh-pages@v4
if: github.ref == 'refs/heads/main'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./build-docs
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ dist
coverage
.idea/
*.env*
build-docs
4 changes: 4 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
build
build-docs
node_modules
pnpm-lock.yaml
Loading

0 comments on commit 69dc739

Please sign in to comment.