MkDocs with Cloudflare Pages (minimal configuration)
- Edit
mkdocs.yml
anddocs/index.md
, add more files if needed. - Add the pip package to
requirements.txt
. (Themes and plugins) - Commit to a GitHub project:
git push
- Create a project from Cloudflare Pages and select your GitHub project.
- Enter the following items and select Create Static Site:
- Project name: Any name
- Production branch:
main
,master
, etc. - Framework preset:
Mkdocs
- Wait a moment.
Success: Your site was deployed!
is displayed and the deployment is complete.
Many of the build error are that you mistyped mkdocs.yml
or you forgot to add the package to requirements.txt
.
Check the file change immediately before the error occurred.
This is often not a problem with this project. You should not open an issue for that.