You are viewing the v1.0.0 documentation.

Deployment Configuration

Configure deployment settings in specra.config.json

Deployment Configuration

The deployment section in specra.config.json tells Specra how to build your documentation.

Configuration

Code
json
1{
2 "deployment": {
3 "target": "static"
4 }
5}

For Specra Cloud, set target to "static" — the CLI handles the rest automatically.

Options

target

Type: stringDefault: "vercel"

Controls the build output format.

ValueUse case
"static"Specra Cloud, Netlify, Cloudflare Pages — outputs static HTML/CSS/JS
"vercel"Vercel, Railway, Render — runs as a Node.js server
"github-pages"GitHub Pages without a custom domain
"custom-domain-static"GitHub Pages with a custom domain

basePath

Type: stringDefault: ""

Only needed for GitHub Pages without a custom domain, where your site is served from a subpath (e.g., username.github.io/repo-name). Set this to your repository name:

Code
json
1{
2 "deployment": {
3 "target": "github-pages",
4 "basePath": "my-repo"
5 }
6}

customDomain

Type: booleanDefault: false

Set to true when using a custom domain with GitHub Pages so assets are served from / instead of /repo-name/.

Next Steps