Docusaurus previews your whole team can open

docusaurus build emits a complete static site in build/. For a docs PR, that's a full preview of the changed documentation — it just needs a URL. Two lines of YAML and the link lands on the pull request.

Drop your Docusaurus report here — get a live link

.zip, folder, or single .html — free, no account, live for 7 days.

The artifact dead-end

Docs changes get reviewed as Markdown diffs, but the thing readers see is the rendered site — nav, admonitions, code blocks. Reviewing prose in a diff is how broken formatting ships.

Preview platforms want repo access and accounts for what is literally a static folder.

Two lines to a live link

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

Build the site

npm run build

.github/workflows/ci.yml

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

Or with plain curl — no account needed

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

path: build/ 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

The build/ folder deploys untouched — versioned docs, blog and generated pages all work at the drop root
The default baseUrl of / just works — drops mount at the root of their own subdomain, so internal links resolve without config changes
comment: true puts the preview link on every docs PR automatically

Questions

Does docs versioning work?

Yes — versions are just folders under build/, and every link resolves because the drop serves the folder exactly as Docusaurus wrote it.

Does search work on the preview?

Local-search plugins ship their index as static files and work as-is. Hosted DocSearch crawls your production domain, so previews use whatever fallback your config provides.

How long do previews live?

Anonymous drops expire after 7 days — fine for PR review. On a paid plan you control ttl, or keep a permanent named drop for your main-branch docs.

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 Action All CI recipes

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