GitHub

The mdu GitHub Pages Action renders your documentation and publishes it to GitHub Pages.

  1. In your repository, open Settings → Pages and set Build and deployment → Source to GitHub Actions.
  2. Add this workflow. It runs whenever files under docs/ change on main:
.github/workflows/publish.yml
name: Publish docs

on:
  push:
    branches: [main]
    paths:
      - 'docs/**'

permissions:
  contents: read
  pages: write
  id-token: write

jobs:
  publish:
    runs-on: ubuntu-latest
    environment:
      name: github-pages
    steps:
      - uses: capjan/markdown-util-action@v1

Action inputs and details

Search documentation

Press Esc to close

Start typing to search the documentation.

Media settings

Choose which providers may load videos automatically across this site. Your choices are stored in this browser.