Skip to content

Commit

Permalink
add github action
Browse files Browse the repository at this point in the history
  • Loading branch information
jcubic committed Feb 14, 2024
1 parent 9a2237d commit 1232a6b
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 0 deletions.
35 changes: 35 additions & 0 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: build docs

on:
push:
paths:
- 'docs/**/*'
branches:
- docusaurus

jobs:
deploy:
name: Build Docusaurus to gh-pages
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: 20
cache: npm
cache-dependency-path: docs/package-lock.json

- name: Install dependencies
working-directory: ./docs/
run: cdnpm ci
- name: Build website
working-directory: ./docs/
run: npm run build

- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/build
user_name: github-actions[bot]
user_email: 41898282+github-actions[bot]@users.noreply.github.com
1 change: 1 addition & 0 deletions docs/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ const config: Config = {
// If you aren't using GitHub pages, you don't need these.
organizationName: 'jcubic', // Usually your GitHub org/user name.
projectName: 'lips', // Usually your repo name.
deploymentBranch: 'docusaurus',

onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',
Expand Down

0 comments on commit 1232a6b

Please sign in to comment.