Integrations
Connect Boltdocs with external services — analytics, search, i18n, versioning, SEO, and more.
Boltdocs integrates with popular services and provides built-in features for search, localization, versioning, and SEO. This section covers all available integrations.
Available Integrations
SEO & Analytics
SEO & Robots
Automatic sitemap, robots.txt, and meta tags.
Google Analytics 4
Track page views and custom events with GA4.
Google Tag Manager
Deploy and manage tags, analytics, and custom scripts with GTM.
Vercel Analytics
Monitor traffic and Core Web Vitals with zero-config Vercel Analytics.
Site Verification
Verify ownership with Google, Bing, Yandex, Pinterest, and Facebook.
Search
Search Overview
Built-in search architecture and customization options.
FlexSearch Custom UI
Query offline indices programmatically and build custom search UIs.
Algolia DocSearch
Integrate Algolia cloud search for advanced synonyms and analytics.
Globalization
Internationalization
Multi-language docs with folder-based routing and RTL layouts.
Versioning
Maintain and switch between multiple parallel release versions.
Content Features
Collections
Group documents into blogs, release notes, or tutorials with custom views.
Custom Feedback
Native GitHub Discussion ratings and page-level comments.
Giscus Comments
Add GitHub Discussions-powered comments to your docs.
Built-in Features
Search
Boltdocs ships with zero-dependency full-text search. The search index is built at compile time and embedded in the client bundle. No API keys, no external services.
- Indexing: Titles, headings, descriptions, body text
- Trigger:
Cmd+K/Ctrl+Kor click the search button - Customization: Use
useSearch()hook or<SearchDialog>component
Internationalization
Locale-based routing using folder conventions. Supports RTL languages, automatic fallbacks for untranslated pages, and locale-specific theming.
- Config:
i18n.defaultLocale,i18n.locales - Folder structure:
docs/es/,docs/fr/ - RTL support: Set
direction: 'rtl'in locale config
Versioning
Maintain multiple documentation versions (v1, v2, etc.) in parallel. Each version is a folder at the root of docs/.
- Config:
versions.defaultVersion,versions.versions - Folder structure:
docs/v1/,docs/v2/ - Version switcher: Built into the default layout
SEO & Robots
Automatic meta tags, Open Graph images, sitemap.xml, and robots.txt generation. Fine-grained control per page via frontmatter.
- Config:
seo,robots,siteUrl - Auto-generated:
sitemap.xml,robots.txt - Per-page: Override via frontmatter
seofield
Collections
Group files into dynamic directories using folder-based conventions. Boltdocs automatically maps bracketed folders (e.g. [blog]) to collection routes, enabling custom listing, post views, and isolated layouts.
- Conventions:
layout.tsx,list.tsx,post.tsx - Data Loaders: Type-safe collection loader data is available via
useLoaderData()
External Services
Google Analytics 4
Track page views and custom events. Configure via integrations.ga4 in your config:
integrations: {
ga4: {
measurementId: 'G-XXXXXXXXXX',
},
}
Page views are tracked automatically. Use the useTrackEvent() hook for custom events.
Configuration Reference
| Key | Type | Description |
|---|---|---|
integrations.ga4 | GA4Config | Google Analytics 4 settings |
integrations.feedback | FeedbackConfig | Custom feedback integration settings |
i18n | I18nConfig | Internationalization settings |
versions | VersionsConfig | Versioning settings |
seo | SeoConfig | Global SEO defaults |
robots | RobotsConfig | robots.txt configuration |
siteUrl | string | Required for absolute URLs in sitemap/og:image |