docs: add stream reader API guides #81
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: Deploy Documentation | |
| on: | |
| push: | |
| branches: | |
| - main | |
| - master | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: false | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v6 | |
| - name: Setup Node.js | |
| uses: actions/setup-node@v6 | |
| with: | |
| node-version: '24.15.0' | |
| - name: Setup pnpm | |
| uses: pnpm/action-setup@v6 | |
| - name: Install dependencies | |
| run: pnpm install --frozen-lockfile | |
| - name: Build stax-xml package | |
| run: pnpm --filter=stax-xml build | |
| - name: Generate TypeDoc documentation (converter) | |
| run: pnpm --filter=stax-xml typedoc:converter | |
| - name: Generate TypeDoc documentation (main) | |
| run: pnpm --filter=stax-xml typedoc:main | |
| - name: Add frontmatter to TypeDoc files | |
| run: pnpm --filter=stax-xml-docs exec tsx scripts/add-frontmatter.ts | |
| - name: Build documentation | |
| run: pnpm docs:build | |
| env: | |
| NODE_ENV: production | |
| - name: Setup Pages | |
| id: pages | |
| uses: actions/configure-pages@v6 | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v5 | |
| with: | |
| path: packages/docs/dist | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| needs: build | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v5 |