build(project): move typedoc generated docs to typedocs folder #139
This file contains 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: document generator | |
| on: | |
| push: | |
| branches: | |
| - main | |
| jobs: | |
| build_and_lint: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout the repository | |
| uses: actions/checkout@v2 | |
| - name: Setup Node.js | |
| uses: actions/setup-node@v2 | |
| - name: Retrieve the cached "node-modules" directory (if present) | |
| uses: actions/cache@v2 | |
| id: node_cache | |
| with: | |
| path: node_modules | |
| key: node-modules-${{ runner.os }}-${{ hashFiles('package-lock.json') }} | |
| - name: Install dependencies (if the cached directory was not found) | |
| if: steps.node-cache.outputs.cache-hit != 'true' | |
| run: npm ci --legacy-peer-deps | |
| - name: Create the docs directory locally in CI | |
| run: npx typedoc --out typedocs && node runner.js prepare:docs | |
| - name: Deploy 🚀 | |
| uses: JamesIves/github-pages-deploy-action@4.1.4 | |
| with: | |
| branch: gh-pages | |
| folder: typedocs | |