MkDocs with GitHub Pages via GitHub Actions (minimal configuration)

MkDocs has a mkdocs gh-deploy command, but using this method you can publish the original source to the repository instead of the built HTML. You commit instead of the MkDocs command.

How to use

  1. Edit mkdocs.yml and docs/, add more files if needed.
  2. Add the pip package to requirements.txt . (Themes and plugins)
  3. Commit to a Git project: git push
  4. Select Setting - Pages from the GitHub project, Select GitHub Actions for "Source".
  5. Set "Custom domain" if necessary. (Note: CNAME file does not work with GitHub Actions)