MkDocs

MkDocs ↗ is a modern documentation platform where teams can document products, internal knowledge bases and APIs.

Install MkDocs

MkDocs requires a recent version of Python and the Python package manager, pip, to be installed on your system. To install pip, refer to the MkDocs Installation guide ↗. With pip installed, run:

pip install mkdocs

Create an MkDocs project

Use the mkdocs new command to create a new application:

mkdocs new <PROJECT_NAME>

Then cd into your project, take MkDocs and its dependencies and put them into a requirements.txt file:

pip freeze > requirements.txt

Before you continue

All of the framework guides assume you already have a fundamental understanding of Git ↗. If you are new to Git, refer to this summarized Git handbook ↗ on how to set up Git on your local machine.

If you clone with SSH, you must generate SSH keys ↗ on each computer you use to push or pull from GitHub.

Refer to the GitHub documentation ↗ and Git documentation ↗ for more information.

Create a GitHub repository

Create a new GitHub repository by visiting repo.new ↗. After creating a new repository, go to your newly created project directory to prepare and push your local application to GitHub by running the following commands in your terminal:

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:

1. Log in to the Cloudflare dashboard ↗ and select your account.
2. In Account Home, select Workers & Pages > Create application > Pages > Connect to Git.
3. 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:

Configuration option	Value
Production branch	main
Build command	mkdocs build
Build directory	site

4. Go to Environment variables (advanced) > Add variable > and add the variable PYTHON_VERSION with a value of 3.7.

After deploying your site, you will receive a unique subdomain for your project on *.pages.dev.

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 preview deployments on new pull requests and be able to preview how changes to your site look before deploying them to production.

For the complete guide to deploying your first site to Cloudflare Pages, refer to the Get started guide.

Learn more

By completing this guide, you have successfully deployed your MkDocs site to Cloudflare Pages. To get started with other frameworks, refer to the list of Framework guides.