docs: structuring and overhaul #1020
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: GitHub pages | |
| on: | |
| push: | |
| branches: | |
| - master | |
| paths: | |
| # One day we might include all htdocs folders: | |
| # - '**/htdocs/**' | |
| # Until then, follow jsdoc.conf.json:source directive | |
| - 'modules/luci-base/htdocs/luci-static/resources/**' | |
| - 'docs/**' | |
| jobs: | |
| deploy: | |
| if: endsWith( github.repository, 'luci' ) | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Install | |
| run: npm install | |
| - name: Build | |
| run: npm run doc | |
| - name: Archive docs as artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: docs | |
| path: ./docs/ | |
| - name: Deploy | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./docs/ | |
| enable_jekyll: true |