Built-in plugins

Fibel assembles its default behavior from normal plugins. Projects can use that set as-is, append their own plugins, or replace individual responsibilities.

Default set

import { defaultPlugins } from "@valentinkolb/fibel";

const plugins = defaultPlugins();

The default set includes:

• markdownPlugin: renders Markdown to HTML, processes code blocks, and creates heading anchors.
• themePlugin: reads the theme cookie and provides the selected theme to the layout. See Theme.
• i18nPlugin: checks whether translated pages exist in the configured locales.
• seoPlugin: serves SEO files such as favicon, sitemap, and robots output, and adds language alternates and social card metadata to every page.
• llmsPlugin: serves llms.txt and llms-full.txt so language models can discover and read the documentation. See SEO.
• assetsPlugin: serves files from the configured assets folder.
• searchPlugin: builds the search index and exposes the search endpoint. See Search.
• poweredByPlugin: adds the Powered by fibel.dev attribution to the footer.
• layoutPlugin: renders navigation, page layout, page actions, footer, search dialog, and client script.

Optional plugins

Fibel ships plugins that are not part of the default set because they need configuration.

imprintPlugin adds a footer link to legal information hosted somewhere else. Use it when the imprint belongs to the company or person behind several sites and should not be maintained as a documentation page.

import { defineFibel, defaultPlugins } from "@valentinkolb/fibel";
import { imprintPlugin } from "@valentinkolb/fibel/plugins";

export default defineFibel({
  title: "Product Docs",
  plugins: [...defaultPlugins(), imprintPlugin({ url: "https://example.com/imprint", label: "Imprint" })],
});

The URL is used as written, so it can point at any external page. label defaults to Imprint.

Extend the defaults

Append project plugins to the default set when the built-in behavior should remain active.

import { defineFibel, defaultPlugins } from "@valentinkolb/fibel";
import { projectLinksPlugin } from "./plugins/project-links";

export default defineFibel({
  title: "Product Docs",
  plugins: [...defaultPlugins(), projectLinksPlugin()],
});

This is the right starting point for most projects. The Plugin API describes the available hooks.

Replace the defaults

Replace the plugin list when a project owns rendering, layout, search, or routes itself.

import { defineFibel } from "@valentinkolb/fibel";
import { searchPlugin, themePlugin } from "@valentinkolb/fibel/plugins";

export default defineFibel({
  title: "Product Docs",
  plugins: [
    customMarkdownPlugin(),
    themePlugin(),
    searchPlugin(),
    customLayoutPlugin(),
  ],
});

Fibel does not add omitted plugins automatically. A custom list should include every capability the website needs.

To remove the default footer attribution, use a plugin list without poweredByPlugin.

Routes and ownership

Several built-in plugins own routes. The search plugin owns the search endpoint. The layout plugin serves the client script. The SEO plugin serves SEO files. The assets plugin serves public files.

Custom plugins should choose route paths explicitly. This prevents collisions and keeps documentation predictable under a base path.