Skip to content

Welcome to MkDocs

For full documentation visit mkdocs.org.

For useful commands for the material theme I am using visit material for mkdocs reference

I followed this guide to get mkdocs hosted on cloudflare pages. The main issue was including a requirements.txt with mkdocs and material for mkdocs in it.

The site is hosted on Cloudflare Pages as GitHub Pages wanted money for a private repository. There is a gitHub ci.yml however copying changes to a branch gh-deploy.

The main issue was getting the plugins added using requirements.txt in the parent directory of the project.

mkdocs==1.5.3
mkdocs-material==9.4.0
mkdocs-material-extensions==1.2
mkdocs-table-reader-plugin==2.0.1
mkdocs-pdf==0.1.1
mkdocs-macros-plugin==1.0.4
mkdocs-obsidian-support-plugin==1.2.1
overrides==7.7.0

Commands

  • mkdocs new [dir-name] - Create a new project.
  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs -h - Print help message and exit.

Resources

PDF Rendering Plugin
mkdocs-macros
How I installed mkdocs on OSX
mkdocs-table-reader