intility-bifrost-mkdocs 0.7.2

Intility Bifrost theme plugin for MkDocs Material

Bifrost MkDocs

Intility's Bifrost design system as a Material for MkDocs plugin.

Description

A pip-installable MkDocs plugin that applies Intility's Bifrost design system to Material for MkDocs. The plugin is batteries-included: colors, typography, component styling, markdown extensions, theme features, and admonition icons are all configured automatically.

Installation

uv pip install intility-bifrost-mkdocs

Usage

Add intility-bifrost to your mkdocs.yml plugins:

theme:
  name: material
  palette:
    - scheme: default       # or 'light' — both map to Bifrost light mode
      primary: teal         # Options: teal, purple, pink, yellow
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate         # or 'dark' — both map to Bifrost dark mode
      primary: teal
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

plugins:
  - intility-bifrost
  - search

What it provides

Adding intility-bifrost to your plugins list gives you:

• Bifrost design system - Colors, typography, and component styling matching the Intility design system
• Light/dark mode - Automatic theme switching with Bifrost color variables
• Theme colors - teal, purple, pink, yellow (set via primary in your palette config)
• Typography - Satoshi for headings, Open Sans for body, JetBrains Mono for code
• 23 markdown extensions - Admonitions, code highlighting, tabs, mermaid diagrams, math (MathJax), emoji, task lists, and more
• 13 theme features - Instant navigation, search suggestions, code copy buttons, etc.
• Admonition icons - Custom FontAwesome icons for all admonition types
• Bundled plugins - mkdocs-awesome-nav and mkdocs-git-revision-date-localized-plugin are installed alongside; opt in by adding them to your plugins: list

All defaults are injected only when the user hasn't provided their own config, so you can override anything by setting it explicitly in your mkdocs.yml.

Local development

This project uses mise for tooling and just as a task runner:

mise install   # installs uv, Python, Node, just and lefthook
just setup     # syncs dev dependencies and installs git hooks
just dev       # serve the docs site locally

Run just to see all available recipes. The demo site at docs/index.md uses the plugin directly. See CONTRIBUTING.md for the full workflow.