https://github.com/intility/bifrost-mkdocs
Plugin for Bifrost themed mkdocs
https://github.com/intility/bifrost-mkdocs
mkdocs plugin secmgmt
Last synced: 4 months ago
JSON representation
Plugin for Bifrost themed mkdocs
- Host: GitHub
- URL: https://github.com/intility/bifrost-mkdocs
- Owner: intility
- License: mit
- Created: 2025-10-29T12:34:28.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2026-02-24T13:43:48.000Z (4 months ago)
- Last Synced: 2026-02-24T13:44:36.775Z (4 months ago)
- Topics: mkdocs, plugin, secmgmt
- Language: CSS
- Homepage: https://intility.github.io/bifrost-mkdocs
- Size: 186 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
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
```bash
uv pip install intility-bifrost-mkdocs
```
## Usage
Add `intility-bifrost` to your `mkdocs.yml` plugins:
```yaml
theme:
name: material
palette:
- scheme: light
primary: teal # Options: teal, purple, pink, yellow
toggle:
icon: material/brightness-7
name: Switch to dark mode
- scheme: dark
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
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
```bash
uv venv .venv
source .venv/bin/activate
uv pip install -e ".[dev]"
mkdocs serve
```
This installs the plugin in editable mode with dev dependencies (ruff, pytest, livereload, git-revision-date plugin). The demo site at `docs/index.md` uses the plugin directly.