stackapRequest access

Frameworks

Docusaurus on Stackap

Stackap builds a Docusaurus documentation site and serves the build folder from nginx, using the 404 page Docusaurus generates.

How Stackap recognizes Docusaurus

A project counts as a Docusaurus site when it has a build script and lists @docusaurus/core as a dependency. It takes the static-site path, which returns real 404 responses. Docusaurus's default scripts include a build script, so no renaming is needed.

What Stackap builds

Docusaurus writes its finished site to build, which is on Stackap's list of output folders. The generated image runs the build, copies that folder into nginx, and serves it.

Docusaurus also writes a 404.html, which Stackap's nginx configuration is set to use for missing pages, so your own not-found page appears with a real 404 status.

The one setting that most often breaks a first deploy is baseUrl. It defaults to /, which is correct for a site on its own domain. Projects that were published under a sub-path, such as a repository name, often carry a different value that must be changed back.

What a Docusaurus project needs

Verification status

The shared static path has a real Docker build in the platform tests.

Still to verify: a Docusaurus build by us, including versioned docs, the search plugin, or internationalization with several locales, which write extra folders.

Early-access scope

Questions

Why are my links broken after deploying?
Almost always baseUrl. Set it to / for a site on its own domain.
Can I use versioned docs?
Versioned docs are folders in your repository that Docusaurus builds into the output, so there is nothing Stackap-specific. A long version history lengthens the build, and the build shares the machine with live apps.
Does it handle several languages?
Docusaurus writes each locale to a subfolder, which the static server serves like any other path. We have not tested it end to end.

Stackap is in early access. Tell us what you run and we will reply with a straight answer about whether it fits.

Ask for an invitation

Last updated .