intility-bifrost-mkdocs 0.3.0__tar.gz

intility_bifrost_mkdocs-0.3.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Intility AS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

intility_bifrost_mkdocs-0.3.0/PKG-INFO

@@ -0,0 +1,30 @@
+Metadata-Version: 2.4
+Name: intility-bifrost-mkdocs
+Version: 0.3.0
+Summary: Intility Bifrost theme plugin for MkDocs Material
+Author-email: Erlend Ellefsen <erlend.ellefsen@intility.no>
+License-Expression: MIT
+Project-URL: Homepage, https://intility.github.io/bifrost-mkdocs
+Project-URL: Documentation, https://intility.github.io/bifrost-mkdocs
+Project-URL: Repository, https://github.com/intility/bifrost-mkdocs
+Project-URL: Issues, https://github.com/intility/bifrost-mkdocs/issues
+Project-URL: Changelog, https://github.com/intility/bifrost-mkdocs/blob/main/CHANGELOG.md
+Keywords: mkdocs,mkdocs-material,mkdocs-plugin,documentation,bifrost,intility,theme
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: MkDocs
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.10
+License-File: LICENSE
+Requires-Dist: mkdocs>=1.6.1
+Requires-Dist: mkdocs-material<10,>=9.7.0
+Provides-Extra: dev
+Requires-Dist: mkdocs-git-revision-date-localized-plugin>=1.5.0; extra == "dev"
+Requires-Dist: livereload>=2.7.1; extra == "dev"
+Requires-Dist: ruff>=0.15.0; extra == "dev"
+Requires-Dist: pytest>=9.0.0; extra == "dev"
+Dynamic: license-file

intility_bifrost_mkdocs-0.3.0/README.md

@@ -0,0 +1,90 @@
+<h1 align="center">
+  <img src="https://avatars.githubusercontent.com/u/35199565" width="124px"/><br/>
+  Bifrost MkDocs
+</h1>
+
+<p align="center">
+    <em>Intility's Bifrost design system as a Material for MkDocs plugin.</em>
+</p>
+<p align="center">
+    <a href="https://python.org">
+        <img src="https://img.shields.io/badge/python-v3.10+-blue.svg?logo=python&logoColor=white&label=python" alt="Python version">
+    </a>
+    <a href="https://squidfunk.github.io/mkdocs-material/">
+        <img src="https://img.shields.io/badge/mkdocs--material-9.7.0+-blue.svg?logo=materialformkdocs&logoColor=white&label=mkdocs-material" alt="MkDocs Material version">
+    </a>
+    <a href="https://github.com/intility/bifrost-mkdocs/blob/main/LICENSE">
+        <img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License">
+    </a>
+</p>
+
+## 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.
+
+## Resources
+
+[**Documentation**](https://intility.github.io/bifrost-mkdocs/)
+| [**Template**](https://github.com/intility/bifrost-mkdocs-template)
+| [**MIT License**](https://github.com/intility/bifrost-mkdocs/blob/main/LICENSE)
+
+## Installation
+
+```bash
+uv pip install intility-bifrost-mkdocs
+```
+
+To pin a specific version in your `requirements.txt`:
+
+```
+intility-bifrost-mkdocs==0.2.1
+```
+
+## Usage
+
+Add `intility-bifrost` to your `mkdocs.yml` plugins:
+
+```yaml
+theme:
+  name: material
+  palette:
+    - scheme: light
+      primary: &bifrost_theme teal  # Options: teal, purple, pink, yellow
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    - scheme: dark
+      primary: *bifrost_theme
+      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.

intility_bifrost_mkdocs-0.3.0/pyproject.toml

@@ -0,0 +1,78 @@
+[project]
+name = "intility-bifrost-mkdocs"
+version = "0.3.0"
+description = "Intility Bifrost theme plugin for MkDocs Material"
+authors = [
+    { name = "Erlend Ellefsen", email = "erlend.ellefsen@intility.no" },
+]
+keywords = [
+    "mkdocs",
+    "mkdocs-material",
+    "mkdocs-plugin",
+    "documentation",
+    "bifrost",
+    "intility",
+    "theme",
+]
+requires-python = ">=3.10"
+license = "MIT"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Framework :: MkDocs",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+dependencies = [
+    "mkdocs>=1.6.1",
+    "mkdocs-material>=9.7.0,<10",
+]
+
+[project.optional-dependencies]
+dev = [
+    "mkdocs-git-revision-date-localized-plugin>=1.5.0",
+    "livereload>=2.7.1",
+    "ruff>=0.15.0",
+    "pytest>=9.0.0",
+]
+
+[project.urls]
+Homepage = "https://intility.github.io/bifrost-mkdocs"
+Documentation = "https://intility.github.io/bifrost-mkdocs"
+Repository = "https://github.com/intility/bifrost-mkdocs"
+Issues = "https://github.com/intility/bifrost-mkdocs/issues"
+Changelog = "https://github.com/intility/bifrost-mkdocs/blob/main/CHANGELOG.md"
+
+[project.entry-points."mkdocs.plugins"]
+intility-bifrost = "intility_bifrost_mkdocs.plugin:IntilityBifrostPlugin"
+
+[build-system]
+requires = ["setuptools>=75"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+intility_bifrost_mkdocs = [
+    "overrides/**/*.html",
+    "overrides/**/*.css",
+    "overrides/**/*.woff2",
+    "overrides/**/*.js",
+]
+
+[tool.ruff]
+target-version = "py310"
+line-length = 88
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B", "SIM", "RUF"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["intility_bifrost_mkdocs"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

intility_bifrost_mkdocs-0.3.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

intility_bifrost_mkdocs-0.3.0/src/intility_bifrost_mkdocs/__init__.py

@@ -0,0 +1 @@
+"""Intility Bifrost theme plugin for MkDocs Material."""