Configuration Reference

import type { PteroConfig } from 'ptero-core';

const config: PteroConfig = {
	// Your configuration here
};

export default config;

site: {
  title: 'My Documentation',
  description: 'Comprehensive documentation for my project',
  url: 'https://docs.example.com',
  logo: '/logo.svg',
  favicon: '/favicon.ico',
  social: {
    github: 'https://github.com/username/repo',
    twitter: 'https://twitter.com/username'
  }
}

title: 'Ptero Documentation';

description: 'Modern documentation engine for SvelteKit';

url: 'https://docs.example.com';

baseUrl: '/docs'; // Site accessible at example.com/docs

logo: '/images/logo.svg';

favicon: '/favicon.ico';

social: {
  github: 'https://github.com/username/repo',
  twitter: 'https://twitter.com/username',
  discord: 'https://discord.gg/invite',
  linkedin: 'https://linkedin.com/company/name'
}

versions: {
  current: 'v2.0',
  available: [
    { id: 'v2.0', label: 'v2.0', status: 'latest' },
    { id: 'v1.5', label: 'v1.5', status: 'stable' },
    { id: 'v1.0', label: 'v1.0', status: 'legacy' },
    { id: 'v3.0', label: 'v3.0-beta', status: 'next' }
  ],
  aliases: {
    latest: 'v2.0',
    stable: 'v1.5',
    next: 'v3.0'
  }
}

current: 'latest';

available: [
	{
		id: 'v2.0', // Version identifier (folder name)
		label: 'v2.0', // Display label
		status: 'latest' // Badge: latest, stable, legacy, next
	}
];

aliases: {
  latest: 'v2.0',    // /docs/latest → /docs/v2.0
  next: 'v3.0'       // /docs/next → /docs/v3.0
}

sidebar: {
	sections: [
		{
			title: 'Introduction',
			items: [
				{ title: 'What is Ptero?', slug: 'intro/what-is-ptero' },
				{ title: 'Installation', slug: 'intro/installation' }
			]
		},
		{
			title: 'Guides',
			items: [
				{ title: 'Configuration', slug: 'guides/configuration' },
				{ title: 'Content Authoring', slug: 'guides/content-authoring' }
			]
		}
	];
}

sections: [
	{
		title: 'Getting Started',
		collapsed: false,
		items: [
			{ title: 'Introduction', slug: 'intro' },
			{
				title: 'Installation',
				slug: 'installation',
				items: [
					// Nested items
					{ title: 'Quick Start', slug: 'installation/quick-start' },
					{ title: 'Manual Setup', slug: 'installation/manual' }
				]
			}
		]
	}
];

theme: {
  primary: '#3b82f6',
  dark: {
    primary: '#60a5fa'
  },
  font: {
    sans: 'Inter, system-ui, sans-serif',
    mono: 'Fira Code, monospace'
  },
  darkMode: 'class',
  defaultMode: 'light'
}

primary: '#ff3e00'; // Svelte orange

dark: {
  primary: '#ff6b35',
  background: '#0a0a0a',
  text: '#f5f5f5'
}

font: {
  sans: 'Inter, -apple-system, system-ui, sans-serif',
  mono: '"Fira Code", "JetBrains Mono", monospace'
}

darkMode: 'class';

defaultMode: 'dark';

search: {
  enabled: true,
  placeholder: 'Search documentation...',
  hotkey: 'k',
  resultsLimit: 20,
  fuzzyThreshold: 0.3,
  indexFields: ['title', 'description', 'content', 'headings']
}

enabled: true;

placeholder: 'Search docs (⌘K)';

hotkey: 'k'; // Cmd+K / Ctrl+K

resultsLimit: 10;

fuzzyThreshold: 0.2; // More strict

indexFields: ['title', 'description', 'content', 'headings', 'keywords'];

navigation: {
  breadcrumbs: true,
  prevNext: true,
  editLink: {
    pattern: 'https://github.com/user/repo/edit/main/src/content/docs/{slug}.md',
    text: 'Edit this page'
  },
  feedback: {
    enabled: true,
    helpful: 'Was this page helpful?',
    yes: 'Yes',
    no: 'No'
  }
}

breadcrumbs: true;

prevNext: true;

editLink: {
  pattern: 'https://github.com/user/repo/edit/main/src/content/docs/{slug}.md',
  text: 'Edit this page on GitHub'
}

feedback: {
  enabled: true,
  helpful: 'Was this helpful?',
  yes: 'Yes',
  no: 'No',
  onFeedback: (helpful, page) => {
    // Track feedback
    analytics.track('page_feedback', { helpful, page });
  }
}

metadata: {
  openGraph: {
    type: 'website',
    siteName: 'My Docs',
    image: '/og-image.png'
  },
  twitter: {
    card: 'summary_large_image',
    site: '@username',
    creator: '@username'
  }
}

import type { PteroConfig } from 'ptero-core';

const config: PteroConfig = {
	site: {
		title: 'Ptero Documentation',
		description: 'Modern documentation engine for SvelteKit',
		url: 'https://ptero.dev',
		logo: '/logo.svg',
		social: {
			github: 'https://github.com/username/ptero'
		}
	},

	versions: {
		current: 'latest',
		available: [{ id: 'v1.0', label: 'v1.0', status: 'latest' }]
	},

	sidebar: {
		sections: [
			{
				title: 'Introduction',
				items: [
					{ title: 'What is Ptero?', slug: 'intro/what-is-ptero' },
					{ title: 'Installation', slug: 'intro/installation' }
				]
			}
		]
	},

	theme: {
		primary: '#3b82f6',
		font: {
			sans: 'Inter, sans-serif',
			mono: 'Fira Code, monospace'
		}
	},

	search: {
		enabled: true,
		resultsLimit: 20
	},

	navigation: {
		editLink: {
			pattern: 'https://github.com/user/repo/edit/main/src/content/docs/{slug}.md'
		}
	}
};

export default config;

import type {
	PteroConfig,
	SiteConfig,
	VersionConfig,
	SidebarConfig,
	ThemeConfig,
	SearchConfig
} from 'ptero-core';