Configure GitHub pages with docsify (#43) #20
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Documentation | |
| on: | |
| push: | |
| branches: | |
| - main | |
| paths: | |
| - 'README.md' | |
| - 'doc/**/*' | |
| - '.github/workflows/doc.yml' | |
| jobs: | |
| build-doc: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write | |
| pages: write | |
| id-token: write | |
| steps: | |
| - uses: actions/checkout@v5 | |
| - name: Setup Node.js | |
| uses: actions/setup-node@v5 | |
| with: | |
| node-version: 22 | |
| cache: npm | |
| - name: Enable corepack | |
| run: corepack enable | |
| - name: Install Yarn | |
| run: corepack install | |
| - name: Get Yarn cache folder | |
| id: yarn-cache-dir | |
| run: echo "cache-dir=$(corepack yarn config get cacheFolder)" >> $GITHUB_OUTPUT | |
| - name: Restore Yarn cache | |
| uses: actions/cache@v4 | |
| with: | |
| path: ${{ steps.yarn-cache-dir.outputs.cache-dir }} | |
| key: yarn-${{ runner.os }}-${{ hashFiles('yarn.lock') }} | |
| - name: Install dependencies | |
| run: corepack yarn install --immutable | |
| - name: Generate docs | |
| run: corepack yarn run doc | |
| - name: Configure pages | |
| uses: actions/configure-pages@v4 | |
| - name: Add typedoc to site | |
| run: mv build/doc/ .github/site/typedoc/ | |
| - name: Add markdown files to site | |
| run: mv *.md doc/ ext/ .github/site/ | |
| - name: Upload pages artifact | |
| uses: actions/upload-pages-artifact@v4 | |
| with: | |
| path: .github/site/ | |
| - name: Deploy pages | |
| uses: actions/deploy-pages@v4 |