Getting Started
Follow these steps to add integrations to Blume and extend your documentation site.
@tai-kun/blume-integrations is a collection of Astro integrations that add small features to Blume documentation sites.
Included integrations
| Integration | Description | Required configuration |
|---|---|---|
routeByBrowserLanguage() |
Redirects default-locale URLs to the locale that matches the visitor’s browser language. | Blume’s i18n (defaultLocale and locales) |
typeTableDetailsIds() |
Adds stable IDs to each TypeTable row and turns property names into links to those IDs. |
None |
Requirements
| Package | Version |
|---|---|
| Astro | 7.0.0 or later |
| Blume | 2.0.0 or later |
Install
npm install @tai-kun/blume-integrationspnpm add @tai-kun/blume-integrationsyarn add @tai-kun/blume-integrationsbun add @tai-kun/blume-integrationsnub add @tai-kun/blume-integrationsaube add @tai-kun/blume-integrationsSetup
Add the integrations to integrations in blume.config.ts. The following example enables the integration that adds IDs to TypeTable rows.
import { typeTableDetailsIds } from "@tai-kun/blume-integrations";
import { defineConfig } from "blume";
export default defineConfig({
integrations: [typeTableDetailsIds()],
});To use routeByBrowserLanguage(), set Blume’s i18n defaultLocale to one of the codes in locales and keep the default locale’s content at the content root. See Route by browser language for the full setup.