Log in Sign up free

Static by default

How to publish a MkDocs site

MkDocs turns a folder of Markdown into a finished documentation site. The output folder is called site, which is the detail people get wrong.

Build command
mkdocs build
Folder to upload
site
Upload your site folder How it works

Free plan, free SSL, no credit card.

.droply.id

  1. Build the project

    Run mkdocs build in the project folder. This is the step Droply does not do for you: we publish finished pages, we never run your build.

  2. Find the output folder

    The build writes a finished site to site. That folder, not the project folder, is what gets uploaded.

  3. Drag it in

    Drop the folder (or a ZIP of it) into Droply. It is live on an HTTPS droply.id subdomain in seconds, and re-uploading publishes a new version at the same URL.

Worth knowing about MkDocs

  • The folder to upload is site, not docs. docs holds your Markdown source, and uploading that publishes your source rather than your site.

  • site_dir in mkdocs.yml changes the output folder. Read it before assuming the default.

  • Set site_url to the address the site will live at. The search index and the canonical tags in Material for MkDocs both read it.

  • Use mkdocs build, not mkdocs gh-deploy. The second one commits to a gh-pages branch, which is a different destination entirely.

Did an AI tool build this project?

Hosting an AI-generated website covers the question that comes before the build command: whether what you are holding is a single file or a project, and which of the two every tool actually hands back.

Frequently asked questions

Does Droply build my MkDocs project for me?
No, and it never will. Droply publishes finished static files. Running your build would mean running your dependencies on our servers, which is a different and much riskier product. Build locally or in your existing CI, then upload the result.
Which folder do I upload?
The site folder that mkdocs build creates, not the project folder. Upload it directly or ZIP it first; both work.
What happens when I update the site?
Build again and upload again. The new version replaces the old one at the same URL, so a link you have already shared keeps working. The Pro, Business and Enterprise plans keep a version history you can roll back to in one click.
Can I use my own domain?
Yes, on the Pro, Business and Enterprise plans. Point your domain at Droply, and the certificate is issued and renewed automatically.
Quarto Slidev Storybook Vite