Docusaurus builds your documentation into a static site in build/: every doc and blog post as HTML, with search and navigation that run in the browser. Lobsite hosts that folder. Run npm run build, then npx lobsite, and your docs are live at a *.lobsite.app address with HTTPS. Every deploy also gets its own URL, which is handy for reviewing docs changes before they go live.
How it works
- Build the docs with
npm run build. Docusaurus writes the site tobuild/, and fails the build on broken links by default. - Run
npx lobsitein the project. It deploysbuild/, notstatic/. The first deploy needs no account and lasts 6 hours. - Keep it with the claim link, in a free account. After that,
npm run build && npx lobsiteupdates the same address.
url, baseUrl and trailing slashes
// docusaurus.config.js
export default {
url: "https://my-docs.lobsite.app",
baseUrl: "/",
};
urlis your site's address. Docusaurus uses it for canonical links and the sitemap.baseUrlis/on Lobsite. A GitHub Pages project site uses/repo-name/; leaving that in breaks every asset link.trailingSlashcan be left out. Docs built asdocs/intro/index.htmlopen at/docs/intro/;/docs/introredirects there.
Reviewing docs changes
Docs are written by many people and often reviewed by someone else. lobsite deploy --preview publishes the build at its own URL without touching the live docs, so a reviewer reads the change as it will look. lobsite promote makes it live, and lobsite rollback goes back to the previous version in one step. Moving pages around? Add redirects for the old paths to lobsite.toml so links from search results and other sites keep working; the Redirect Generator writes the rules. AI coding agents can run the same deploy with npx -y lobsite --yes, which never stops to ask a question.
Preview before going live. Roll back in one click, redirects and all.
Files are stored by their hash. Redeploying an unchanged site uploads 0 bytes.
Every site gets a *.lobsite.app address with HTTPS from the first deploy.
Redirects, headers and forms live in lobsite.toml and travel with each deploy.
No prompts under an agent, and a Tell the user: line with the URL and the claim link.
Every limit is published, and every error tells you what to do next.
Docusaurus hosts compared
| Lobsite | GitHub Pages | Netlify | Vercel | |
|---|---|---|---|---|
| Builds the docs for you | No: you deploy build/ |
In GitHub Actions, or docusaurus deploy |
Yes | Yes |
| Preview URL for every deploy | Yes | No | Yes | Yes |
| Rollback in one step | Yes | Revert a commit | Yes | Yes |
| Account before the first deploy | No: live 6 hours, then keep it free | Yes, and a repository | Yes | Yes |
| Custom domain | Yes, free | Yes, free | Yes | Yes |
GitHub Pages works well for open-source docs that live next to the code. Lobsite suits docs you build locally or in CI and want to preview, promote and roll back without a Git workflow around the hosting.
Frequently asked questions
Which baseUrl should Docusaurus use on Lobsite?
/. The site is served from the top of its address. Only a GitHub Pages project site needs /repo-name/.
Does Docusaurus search work on a static host?
Yes. Algolia DocSearch runs in the visitor's browser, and local search plugins build their index into build/. Neither needs a server.
Can I host versioned Docusaurus docs?
Yes. Every version is built into build/ as its own pages, so they all deploy together. Only the files that changed since the last deploy are uploaded.
How big can a Docusaurus site be?
On the free plan, up to 1,000 files and 50 MB per deploy, which fits most docs sites. Larger docs with many versions or images need the paid plan, coming soon; every limit is on the limits table.