Deploy guide
How to deploy MkDocs
MkDocs builds your site to a folder of plain files. Here's how to build it, which folder to publish, and the setup on each host.
mkdocs buildsite
Pick a host
Where do you want it?
Before any host
Build it
Run mkdocs build. The site comes out in site: that folder is what goes online, whichever host you pick.
Good to know
Worth knowing first
- If you use a theme or plugins, such as Material for MkDocs, put them in
requirements.txtand change the install line in the workflow topip install -r requirements.txt. - MkDocs also has
mkdocs gh-deploy, which builds on your computer and pushes to agh-pagesbranch. Then set Source to Deploy from a branch and pickgh-pages.
Or skip the setup
Drop it in. It's online in seconds.
A file, a folder or a whole site: 99helpers puts it online at its own address, with no git, no build settings and no DNS to start with. Add your own domain whenever you're ready.