Configuration Guide (v1)

Deprecated: This guide is for v1. See the v2 configuration guide for current options.

Basic Configuration

Edit astro.config.mjs:

import shipyard from '@levino/shipyard-base'
import shipyardDocs from '@levino/shipyard-docs'

export default defineConfig({
  integrations: [
    shipyard({
      siteTitle: 'My Project',
      siteTagline: 'A great project',
      brandName: 'MyApp',
    }),
    shipyardDocs({
      docsRoot: './docs',
    }),
  ],
})

v1 Configuration Options

Site Settings

Option	Type	Description
siteTitle	string	Page title
siteTagline	string	Subtitle text
brandName	string	Navigation brand

Docs Settings

Option	Type	Description
docsRoot	string	Docs directory path
editUrl	string	GitHub edit URL

Limitations

v1 configuration does not support:

• Documentation versioning
• Advanced sidebar configuration
• Custom theme options

These features are available in v2.

Migrating Configuration

When upgrading to v2, rename these options:

• siteTitle → title
• siteTagline → tagline
• brandName → brand

See the Migration Guide for complete instructions.