Configuration
Configure your Doculite documentation site.
Site Configuration
Edit lib/site-config.ts to customize your documentation site:
import type { DoculiteConfig } from "@/lib/config-types";
export const siteConfig: DoculiteConfig = {
name: "My Docs",
description: "Documentation for my project.",
url: "https://docs.example.com",
navLinks: [
{ title: "Docs", href: "/docs" },
{ title: "GitHub", href: "https://github.com/...", external: true },
],
socialLinks: [
{ platform: "github", url: "https://github.com/..." },
],
footer: {
text: "Built with Doculite.",
},
github: {
repo: "owner/repo",
editUrl: "https://github.com/owner/repo/edit/main/content",
},
};Configuration Fields
| Field | Type | Description |
|---|---|---|
name | string | Site name shown in header and metadata |
description | string | Site description for SEO |
url | string? | Production URL |
navLinks | NavLink[] | Header navigation links |
socialLinks | SocialLink[]? | Social media links (GitHub, Twitter, Discord) |
footer.text | string? | Footer text |
github.repo | string? | GitHub repository (owner/repo) |
github.editUrl | string? | Base URL for "Edit this page" links |
Restart Required
Configuration changes require restarting the development server since the config is imported at build time.
Content Configuration
Velite Schema
Content schema is defined in velite.config.ts. Each MDX file supports these frontmatter fields:
| Field | Type | Default | Description |
|---|---|---|---|
title | string | required | Page title |
description | string? | — | Page description for SEO and search |
order | number | 999 | Sort order in sidebar |
published | boolean | true | Whether page appears in production |