Deploy an MkDocs site
$ pip install mkdocs
Create an MkDocs project
mkdocs new command to create a new application:
$ mkdocs new <PROJECT_NAME>
cd into your project, take MkDocs and its dependencies and put them into a
pip freeze > requirements.txt
Before you continue
Create a GitHub repository
$ git init$ git remote add origin https://github.com/<your-gh-username>/<repository-name>$ git add .$ git commit -m "Initial commit"$ git branch -M main$ git push -u origin main
You have successfully created a GitHub repository and pushed your MkDocs project to that repository.
Deploy with Cloudflare Pages
To deploy your site to Pages:
- Log in to the and select your account.
- In Account Home, select Workers & Pages > Create application > Pages > Connect to Git.
- Select the new GitHub repository that you created and, in the Set up builds and deployments section, select MkDocs as your Framework preset. Your selection will provide the following information:
- Go to Environment variables (advanced) > Add variable > and add the variable
PYTHON_VERSIONwith a value of
After deploying your site, you will receive a unique subdomain for your project on
Every time you commit new code to your MkDocs site, Cloudflare Pages will automatically rebuild your project and deploy it. You will also get access to on new pull requests and be able to preview how changes to your site look before deploying them to production.