stackapRequest access

Frameworks

VitePress on Stackap

Stackap builds a VitePress site and serves its .vitepress/dist folder, but VitePress's default script is named docs:build, so you need to add a script called build first.

How Stackap recognizes VitePress

A project counts as a VitePress site when it lists vitepress as a dependency and has a script named build. VitePress's documentation suggests docs:dev, docs:build and docs:preview. None of those is called build, so a project created from the guide is not recognized until you add an alias.

What Stackap builds

Add "build": "vitepress build docs", adjusting the folder to wherever your pages live. The generated image runs it, then looks for the output in .vitepress/dist or docs/.vitepress/dist, which are the two VitePress locations on Stackap's list.

The result is plain HTML, served by nginx with real 404 responses.

VitePress has a base option for sites published under a sub-path. On a domain of its own it should be /.

What a VitePress project needs

Verification status

The folder names are on the list the generated Dockerfile searches, and the shared static path has a real Docker build in the platform tests.

Still to verify: a VitePress build by us.

Early-access scope

Questions

Is a sub-path deployment supported?
The server serves whatever your build produces from the root of the domain, so a site built with a sub-path base will have broken links on its own domain. Build it with base: "/".
Does it get a custom 404 page?
VitePress writes a 404.html, which the web server uses for missing paths, so your not-found page is served with a real 404 status.
What if my docs are in a subfolder?
Put that folder in the build script you add. Stackap searches both .vitepress/dist and docs/.vitepress/dist, so either layout works without further settings.
Does search work?
VitePress's built-in local search is generated at build time into the output, so it works from the static files. We have not tested it ourselves.

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 .