n nesly

Deploy MkDocs

How nesly detects, builds and serves a MkDocs project — and the two commands that put it on a live URL.

Deploy MkDocs on nesly

A MkDocs project is built once and served as static files — no server process to keep alive.

cd your-project
nesly deploy --yes

The first deploy creates the project and prints the live URL; after that, nesly deploy is enough.

How detection sees it

  • A mkdocs.yml is detected as MkDocs. With a requirements.txt the build installs exactly that (your theme included); without one, stock mkdocs is installed.
  • mkdocs build writes site/, which is served as static files.

When detection is not what you want, say it yourself: build and start commands, root directory and output directory live in nesly.toml committed next to the code — see builds.

Worth knowing

  • mkdocs-material and every plugin your mkdocs.yml names must be in requirements.txt — the build machine starts clean, and mkdocs fails with a clear message when a theme is missing.
  • When a deploy fails, nesly diagnose reads the logs for you and names the fix.

Full walkthrough: get started. Custom domains, backups, GitHub deploys and the rest of the reference: nesly CLI.