Skip to content

mkdocs build, then one POST — docs on a URL

mkdocs build writes a complete static site — theme, search index, everything — into site/. Deploying it is one POST request, from your shell or from CI.

Drop your MkDocs report here — get a live link

free, no account, live for 7 days.

The artifact dead-end

The standard MkDocs hosting answer is Read the Docs or GitHub Pages — both want repo integration and per-project setup. Sharing a work-in-progress docs branch shouldn't require either.

Reviewing docs as a Markdown diff misses what readers actually see: the rendered nav, admonitions, and search.

Two lines to a live link

Build your output like you already do, then hand the folder to the action:

Build the site

mkdocs build

.github/workflows/ci.yml

- uses: bitgate/ship-page-action@v1
  if: always()
  with:
    path: site/

Or with plain curl — no account needed

cd site && zip -qr - . | curl -fsS -X POST https://ship.page/deploy \
  -H "Content-Type: application/zip" \
  --data-binary @- | jq -r .url

path: site/ deploys exactly what the tool wrote — no detection to configure. The link goes in the job summary — add comment: true and it lands on the pull request too.

What you get

  • site/ deploys exactly as built — Material theme assets and the client-side search index resolve at the drop root
  • The default use_directory_urls produces real folders with index.html files — exactly what static serving wants
  • From Jenkins, GitLab or a plain shell it's one curl; from GitHub Actions it's path: site/

Questions

Does search work?

Yes — MkDocs builds a client-side search index (search/search_index.json) inside site/, served like any other file.

Does it work with MkDocs Material Insiders?

Same thing — build with your Insiders setup and deploy site/. The output is static either way.

Can I keep a stable URL for develop docs?

Yes: name: docs-develop plus an sp_ API key redeploys the same URL on every push to the branch.

Try it on your next run

Anonymous deploys need no account and no key — paste the step, get a link. When you want stable URLs that redeploy in place, an API key and a name are all it takes.

Get the GitHub ActionAll CI recipes

Need to share the report with someone outside GitHub? How to share a GitHub Actions artifact without a login.