Skip to content

Github Action

Deploy from GitHub Actions

Create a YAML file with the following contents in the .github/workflows directory in your repository

jobs:
  docs:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v2
      - name: Build docs
        id: mkdocs
        uses: athackst/mkdocs-simple-plugin
        with:
          # (optional) Specify branch
          publish_branch: gh-pages
          # (optional) The URL of the repository the docs should point to
          repo_url: https://github.com/owner/repository
          # (optional) The name of the site
          site_name: owner/repository
          # (optional) The URL of the site
          site_url: https://owner.github.io/repository
          # (optional) The edit URI
          edit_uri: edit/main/
          # (optional) Specify a google analytics key
          google_analytics: UA-XXXXXXX
          # (optional) Specify a different theme [mkdocs|readthedocs|material]
          theme: material
          # (optional) Load a configuration file from a string
          config: "mkdocs.yml"
          # (optional) Version or alias.  Specify multiple aliases with space
          # example: version: v0.1.0 latest
          version: latest
          # (optional) The version that will be served by the root of your site
          default_version: latest
          # (optional) Whether to push the docs to the remote branch
          push: 1
      - name: Upload artifact
        uses: actions/upload-artifact@main
        with:
          name: 'github-pages'
          # Get the filename of the artifact created by the action
          path: ${{ steps.mkdocs.outputs.artifact }}
          retention-days: 1

Last update: August 25, 2023