Update getting started page. #40
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: Build and publish user guide documentation to GitHub Pages | |
| on: | |
| push: | |
| branches: [ "main" ] | |
| workflow_dispatch: | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: false | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| env: | |
| HUGO_VERSION: 0.120.4 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| fetch-depth: 0 | |
| - name: Setup Hugo | |
| uses: peaceiris/actions-hugo@v2 | |
| with: | |
| hugo-version: '0.120.4' | |
| extended: true | |
| - name: Setup node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: '18' | |
| # cache: 'npm' | |
| # The action defaults to search for the dependency file (package-lock.json, | |
| # npm-shrinkwrap.json or yarn.lock) in the repository root, and uses its | |
| # hash as a part of the cache key. | |
| # https://github.com/actions/setup-node/blob/main/docs/advanced-usage.md#caching-packages-data | |
| # cache-dependency-path: '**/package-lock.json' | |
| - run: npm ci | |
| - name: Build with Hugo | |
| env: | |
| # For maximum backward compatibility with Hugo modules | |
| HUGO_ENVIRONMENT: production | |
| HUGO_ENV: production | |
| run: hugo --minify | |
| - name: Deploy to GitHub Pages | |
| if: success() | |
| uses: crazy-max/ghaction-github-pages@v4 | |
| with: | |
| target_branch: gh-pages | |
| build_dir: public | |
| keep_history: true | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |