Appearance
Site Setup Overview
Partner Documentation
This section covers technical integration of sites with the DCS platform. For site owner documentation, see the Portal Guide.
Supported Frameworks
DCS integrates with these frameworks:
| Framework | Support Level | Use Case |
|---|---|---|
| VitePress | Full | Documentation, blogs, marketing |
| Vue 3 SPA | Full | Web applications |
| Nuxt | Partial | SSR applications |
| Static HTML | Basic | Simple sites |
Integration Architecture
Required Files
Every DCS-integrated site needs:
| File | Purpose |
|---|---|
.dcs/site.yaml | Site identity and deployment configuration |
.dcs/pages.yaml | Page registry |
.dcs/content.yaml | Text content overrides (portal-managed) |
.dcs/seo.yaml | SEO metadata (portal-managed) |
.env | Environment variables |
Integration Points
1. Text Content
The useTextContent composable fetches and displays text overrides:
vue
<script setup lang="ts">
import { useTextContent } from '@/lib/use-text-content'
const { t } = useTextContent()
</script>
<template>
<h1>{{ t('home.hero.title', 'Default Title') }}</h1>
</template>2. SEO Metadata
SEO data is managed through the portal and fetched at build or runtime:
typescript
// VitePress frontmatter override
const seo = await fetchSEO('page-slug')
useHead({
title: seo.title,
meta: [
{ name: 'description', content: seo.description }
]
})3. Blog Content
Blog posts are created in the portal and rendered by your site:
typescript
// Fetch blog posts
const posts = await fetchBlogPosts()4. Analytics
Page views and events are automatically tracked:
typescript
// Custom event tracking
trackEvent('button_click', { button: 'cta' })Deployment Model
DCS uses Azure Static Web Apps for hosting:
Environments
| Environment | Branch | Purpose |
|---|---|---|
| Production | master | The live site, on your custom domain |
| Preview | release/** | Review changes on the Static Web App's preview environment before they go to production |
Getting Started
Choose your starting point:
- VitePress Sites — Most common setup
- Configuration Files — Detailed config reference
- GitHub Setup — Repository configuration
Quick Start Checklist
- [ ] Create
.dcs/site.yaml - [ ] Create
.dcs/pages.yaml - [ ] Add
useTextContentcomposable - [ ] Configure environment variables
- [ ] Set up OIDC federated deployment (repository variables +
id-token: write) - [ ] Register site in DCS portal
- [ ] Test integration
Next Steps
- VitePress Sites — Framework-specific guide
- GitHub Setup — Repository configuration
- site.yaml Reference — Config file reference
