mkdocs

A GitHub actions to deploy your MkDocs documentation on GitHub pages.

Prerequisites

• GitHub Pages must be enabled on your project and setup on GitHub Actions

• Don't forget to add the permissions in your workflow file, as showed in example

permissions:
  contents: read
  pages: write       # required by deploy-pages
  id-token: write    # required by deploy-pages

Inputs

Input	Description	Default value
output-dir	Directory containing the static site output	public
workdir	Directory containing mkdocs.yml file	.

Samples

Default configuration

name: Deploy with MkDocs
on:
  push:
    branches: [ "main" ]

## Very important
permissions:
  contents: read
  pages: write       # required by deploy-pages
  id-token: write    # required by deploy-pages

jobs:
  mkdocs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Build & Deploy
        uses: yodamad-actions/[email protected]

All options overriden

name: Deploy with MkDocs
on:
  push:
    branches: [ "main" ]

## Very important
permissions:
  contents: read
  pages: write       # required by deploy-pages
  id-token: write    # required by deploy-pages

jobs:
  mkdocs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Build & Deploy
        uses: yodamad-actions/[email protected]
        with:
          output-dir: public
          workdir: mkdocs