fix(docs): translate README to English #4
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 docs | |
| # Build the mkdocs-material site and deploy to GitHub Pages. | |
| # The CNAME file at the repo root maps the deploy to docs.nullrun.io. | |
| # | |
| # DNS at the registrar (netim.net) must point docs.nullrun.io at GitHub | |
| # Pages. For an apex-style custom domain on a project page, add four A | |
| # records for the `docs` subdomain pointing at the GitHub Pages IPs: | |
| # 185.199.108.153 | |
| # 185.199.109.153 | |
| # 185.199.110.153 | |
| # 185.199.111.153 | |
| # …or a single CNAME record pointing docs.nullrun.io at | |
| # nullrunio.github.io. GitHub's docs walk through both options. | |
| # | |
| # Once the workflow is merged and the DNS records land, enable Pages in | |
| # repo Settings → Pages → Source: "GitHub Actions". The first run after | |
| # that will publish the site at https://docs.nullrun.io. | |
| on: | |
| push: | |
| branches: [master] | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: pages | |
| cancel-in-progress: true | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" | |
| cache: pip | |
| - name: Install mkdocs + material theme | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install \ | |
| mkdocs \ | |
| mkdocs-material \ | |
| pymdown-extensions | |
| - name: Build site | |
| run: mkdocs build --strict | |
| - name: Upload Pages artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: site | |
| deploy: | |
| needs: build | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - id: deployment | |
| uses: actions/deploy-pages@v4 |