GitHubPages-MkDocs
https://github.com/fu-sen/GitHubPages-MkDocs
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
- Edit
mkdocs.yml
anddocs/index.md
, add more files if needed. - Add the pip package to
requirements.txt
. (Themes and plugins) - Commit to a Git project:
git push
- Select Setting - Pages from the GitHub project, Select GitHub Actions for "Source".
- Set "Custom domain" if necessary. (Note:
CNAME
file does not work with GitHub Actions)