@k2b/fibel weekly downloads statistics

Fibel

Fibel publishes Markdown and host-rendered application pages in one documentation shell with native language routes, server-side search, raw Markdown sources, and a cookie-based light/dark theme.

It is built for product and developer documentation that should stay readable in the repository, work well as a website, and remain easy for tools such as LLMs to consume.

Quick start

Fibel targets Bun.

For an app project:

bun add @k2b/fibel
bunx --bun @k2b/fibel init
bunx --bun @k2b/fibel dev --port 5173

Open http://localhost:5173. The root path redirects to the configured default locale.

fibel dev watches the config, docs, and assets. After a successful rebuild, connected browser tabs reload automatically. Use --no-watch or --no-reload when a plain local server is enough.

Package migration

Fibel moved from @valentinkolb/fibel to @k2b/fibel in v0.2.0. Replace root imports with @k2b/fibel, plugin imports with @k2b/fibel/plugins, and CLI commands with bunx --bun @k2b/fibel. The previous package is deprecated and receives no further releases.

Agent skill

Fibel publishes one English Agent Skill for documentation work. Install it directly from the documentation website with the open-source Vercel Skills CLI:

bunx skills add https://fibel.dev

The concise skill gives agents the stable Fibel workflow and tells them to use the public MCP server for exact current API details. It answers in the user's language without maintaining translated copies of the skill.

When working from this repository:

bun install
bun run src/cli.ts init
bun run src/cli.ts dev --port 5173

What Fibel provides

• Documentation pages from docs/<locale>/**/*.md
• Optional content collections with separate Markdown roots and navigation
• Optional date-sorted blog feeds backed by normal Markdown collections
• Framework-neutral custom pages with searchable Markdown content
• Optional Solid SSR and island integration through a host-owned @k2b/ssr build
• A standalone Web-standard fetch app
• Server-rendered HTML with page metadata and canonical URLs
• Server-side search with an interactive spotlight dialog
• Keyboard shortcuts for search with / and Mod+K
• Stable raw Markdown routes with .md and .markdown
• Native language routing and language switching
• Light and dark mode without client-side theme flicker
• Static assets from an assets/ directory
• SEO routes for robots.txt, sitemap.xml, favicon.ico, and favicon.svg
• Language alternates, social cards, and structured data on every page
• llms.txt and llms-full.txt routes for language models
• An optional public MCP endpoint for coding agents
• Optional origin-level Agent Skills discovery from a local directory
• A Tailwind-based default theme
• A small plugin API for replacing or extending built-in behavior

Project structure

.
|-- fibel.config.ts
|-- docs/
|   |-- en/
|   |   |-- index.md
|   |   `-- configuration.md
|   `-- de/
|       |-- index.md
|       `-- configuration.md
`-- assets/
    `-- logo.svg

Each locale has its own folder below docs/. A file at docs/en/configuration.md is served as /en/configuration. The same source is also available as /en/configuration.md and /en/configuration.markdown.

Collections

Related documentation areas can share one Fibel instance, search, assistant, MCP endpoint, and deployment while retaining separate Markdown roots and sidebars:

export default defineFibel({
  title: "Cloud",
  routing: { basePath: "/docs" },
  locales: [
    { code: "en", label: "English" },
    { code: "de", label: "Deutsch" },
  ],
  collections: [
    {
      id: "docs",
      label: "Docs",
      description: "Product documentation.",
      content: "content/docs",
    },
    {
      id: "ui",
      label: "UI",
      description: "Component reference.",
      content: "content/ui",
    },
  ],
  defaultCollection: "docs",
});

Canonical URLs use {basePath}/{locale}/{collection}/{page}, for example /docs/en/ui/button. /docs/ui/button redirects temporarily to the saved, requested, or default locale. Search starts in the current collection and can switch to Everything. Assistant and MCP tools can also select a collection.

Sites without collections keep the existing content directory and URL format.

Blog collections

The optional blog plugin turns one Markdown collection into an editorial feed with date sorting and year navigation:

import { defaultPlugins, defineFibel } from "@k2b/fibel";
import { blogPlugin } from "@k2b/fibel/plugins";

export default defineFibel({
  title: "Product",
  collections: [
    { id: "docs", label: "Docs", content: "content/docs" },
    { id: "blog", label: "Blog", content: "content/blog" },
  ],
  plugins: [...defaultPlugins(), blogPlugin({ collection: "blog" })],
});

Posts require date frontmatter and may set authors. Add <!-- truncate --> after the feed excerpt; without it, the feed uses the page description. Do not add an index.md to the blog collection because the plugin generates that route. Posts remain normal pages for search, Assistant, MCP, raw Markdown, and llms.txt.

Configuration

Create fibel.config.ts at the project root:

import { defineFibel } from "@k2b/fibel";…