Built-in Components

Documentation components you can use directly in your markdown files.

2 min read

Callouts

Use callouts to highlight important information.

This is a note callout. Use it for general information the reader should be aware of.

This is a tip callout. Use it for helpful suggestions and best practices.

This is a warning callout. Use it for potential issues or things to watch out for.

This is a danger callout. Use it for critical warnings about destructive or irreversible actions.

You can also customize the title:

Callouts support custom titles via the `title` prop.

Use tabs to show alternative content, like different package managers:

npm install svelte-docs-starter

Use steps for sequential instructions:

Clone the template repository and install dependencies.

Edit src/lib/docs/config.ts with your site details.

Add markdown files to src/content/docs/.

Build and deploy to your hosting provider.

Use cards to highlight features or key information:

📝 Markdown Powered

Write documentation in Markdown with full MDSvex support for Svelte components.

🔍 Fast Search

Built-in full-text search powered by Pagefind with zero JavaScript overhead.

🌙 Dark Mode

Automatic light and dark theme support with system preference detection.

📈 SEO Ready

OpenGraph, Twitter cards, JSON-LD structured data, and auto-generated sitemap.

Use link cards for navigation:

Use badges to indicate status: New Experimental Deprecated v1.0.0

Display directory structures: