Docs Kickstarter

Configuration

This guide will help you customize and configure your documentation site.

Site Configuration

The main configuration file is astro.config.ts:

import { defineConfig } from 'astro/config'

export default defineConfig({
  site: 'https://your-site.com',
  integrations: [
    // Add your integrations here
  ],
})

Styling

Customize the look and feel of your site by modifying these files:

  • src/styles/global.css - Global styles and CSS variables
  • tailwind.config.ts - Tailwind CSS configuration
  • components.json - shadcn-ui theme configuration

Update the navigation structure by modifying:

  • src/components/docs/DocsSidebar.astro - Documentation sidebar navigation
  • src/components/HeaderEnhanced.astro - Main site navigation

Deployment

This template supports deployment to various platforms:

  • Vercel - Use vercel.json
  • Netlify - Use netlify.toml
  • GitHub Pages - Add the GitHub Actions workflow

Environment Variables

For deployment, you might need to set the following environment variables:

SITE_URL=https://your-site.com
NODE_ENV=production

Build Configuration

The build process can be customized in your package.json:

{
  "scripts": {
    "dev": "astro dev",
    "build": "astro build",
    "preview": "astro preview"
  }
}

Static Assets

Place your static assets in the public directory:

public/
  ├── favicon.ico
  ├── images/
  │   └── logo.png
  └── fonts/
      └── custom-font.woff2

These files will be served directly at the root path of your site.