Configuration schema v1

Generated from schemas/blog-studio.v1.schema.json. Do not edit this page by hand.

Top-level fields

Field	Required	Type	Constraint
version	yes	constant 1	Must equal 1
site	no	object	Unknown keys rejected.
resources	no	object	Unknown keys rejected.
workspace	yes	object	Unknown keys rejected.
generator	yes	object	Unknown keys rejected.
repository	yes	object	Unknown keys rejected.
assets	yes	object	Unknown keys rejected.
publish	yes	object	Unknown keys rejected.
cache	no	object	Unknown keys rejected.
content	no	object	Unknown keys rejected.
developmentProfiles	no	object	See nested schema.
development	no	object	Unknown keys rejected.
verification	no	object	Unknown keys rejected.

All object sections are strict: an unknown key fails configuration loading. An adapter ID uses lowercase kebab-case. Credential values are environment references shaped as { env: "VARIABLE_NAME" }, never literal secrets.

Complete generic example

version: 1

workspace:
  id: example-blog
  root: /workspaces/blog

generator:
  adapter: command
  options:
    displayName: Example command site
    markers: [.blog-studio-example]
    outputDirectory: public
    siteUrl: https://blog.example.com/
    build:
      command: node
      args: [scripts/build.mjs]
      timeoutMs: 120000

repository:
  adapter: local-git
  options:
    remote: origin

assets:
  adapter: filesystem
  options:
    rootDirectory: static
    managedPrefix: media/posts
    protectedPrefixes: [legacy]
    publicBaseUrl: https://blog.example.com/static/

# Authoring and real preview work without a deployment target. Replace this
# with a configured filesystem or remote publisher only after its verification
# URL and rollback boundary are ready.
publish:
  adapter: none

cache:
  adapter: none

content:
  collections:
    posts:
      path: content/posts
      draftPath: content/drafts
      assetScope: media/posts/{documentId}

Optional image processing

Article resources preserve original bytes, format, extension, and metadata when this section is absent or disabled. Enabling it affects only future uploads.

resources:
  imageProcessing:
    enabled: true
    format: webp # original | webp
    quality: 82 # 1..100
    maxWidth: 1920 # 64..16384
    stripMetadata: true

The machine-readable source is the repository’s JSON Schema.