Skip to content

Commit

Permalink
Merge pull request #4 from tshion/feature/setup_jsdoc
Browse files Browse the repository at this point in the history
API ドキュメントをGitHub Pages で公開するように改良
  • Loading branch information
tshion authored Jan 5, 2025
2 parents a4612d7 + 1d6677a commit 7db2974
Show file tree
Hide file tree
Showing 4 changed files with 321 additions and 2 deletions.
22 changes: 22 additions & 0 deletions .github/workflows/prepare-release-note.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,13 @@ jobs:
if: ${{ github.ref_type == 'branch' }}
runs-on: ubuntu-24.04
timeout-minutes: 5
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
permissions:
contents: write
id-token: write
pages: write
steps:
# https://github.com/actions/checkout
- uses: actions/checkout@v4
Expand All @@ -29,6 +34,23 @@ jobs:
cache: npm
cache-dependency-path: ./package-lock.json

- run: npm ci

- name: Generate api docs
run: npm run docs

# https://github.com/actions/configure-pages
- uses: actions/[email protected]

# https://github.com/actions/upload-pages-artifact
- uses: actions/[email protected]
with:
path: out

# https://github.com/actions/deploy-pages
- id: deployment
uses: actions/[email protected]

- name: Get version name
id: meta
run: |
Expand Down
3 changes: 3 additions & 0 deletions conf.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"plugins": ["plugins/markdown"]
}
Loading

0 comments on commit 7db2974

Please sign in to comment.