docs: ESM note as plain blockquote; drop top copyright; © in License … #27
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: Docs | |
| # Builds the docs site and deploys it to GitHub Pages (served at | |
| # onury.io/notation). Self-contained — needs repo Settings → Pages → | |
| # Source = "GitHub Actions". Generated by @onury/docs-kit; edit freely. | |
| on: | |
| push: | |
| branches: [master] | |
| paths: | |
| - 'site/**' | |
| - 'src/**' | |
| - 'README.md' | |
| - 'CHANGELOG.md' | |
| - '.github/workflows/docs.yml' | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| # Allow one concurrent deployment; don't cancel an in-progress run. | |
| concurrency: | |
| group: pages | |
| cancel-in-progress: false | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v5 | |
| - uses: actions/setup-node@v6 | |
| with: | |
| node-version: 22 | |
| cache: npm | |
| # The library root git-ignores its lockfile; cache on the docs lock. | |
| cache-dependency-path: site/package-lock.json | |
| # Root deps so TypeDoc can resolve the library's imported types. Use | |
| # `install` (not `ci`) because the root lockfile isn't committed. | |
| - run: npm install --no-audit --no-fund | |
| - name: Install docs deps | |
| working-directory: site | |
| run: npm ci | |
| - name: Build docs site | |
| working-directory: site | |
| run: npm run build | |
| - uses: actions/configure-pages@v6 | |
| - uses: actions/upload-pages-artifact@v5 | |
| with: | |
| path: site/dist | |
| deploy: | |
| needs: build | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - id: deployment | |
| uses: actions/deploy-pages@v5 |