MkDocs

import { PagesBuildPreset, Render } from "~/components";

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

You have successfully created a GitHub repository and pushed your MkDocs project to that repository.

Deploy with Cloudflare Pages

7. 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.

<Render file="framework-guides/learn-more" product="pages" params={{ one: "MkDocs" }} />