No project description provided
Project description
ADR for MkDocs's Material Theme
ADR are short text documents that captures an important architectural decision made along with its context and consequences.
Install
pip install mkdocs-material-adr
# or
poetry add mkdocs-material-adr
In the mkdocs.yml
file
theme:
# set the name
name: mkdocs-material-adr
# Configuration for the material theme
features:
- navigation.instant
Features
ADR Headers
Information about the ADR are displayed in a header Define information about the ADR in the frontmatter.
---
title: 0004 Title
adr:
author: Jean-Loup Monnier
created: 01-Aug-2023
status: draft | proposed | rejected | accepted | superseded
superseded_by: 0001-test
---
You can change the colors or add new status using css
/* Background color */
.c-pill-<lower_case_status_name> {
background: #a3a3a3;
}
/* Dot color */
.c-pill-<lower_case_status_name>:before {
background: #505050;
}
ADR Graph
WIP
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for mkdocs_material_adr-1.0.1a1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d47d75c0046386d73944fb2cdd95f87a24353e137a20d388f2fd96cfe980870a |
|
MD5 | e6241d186c3c572b5df83772f5c479dc |
|
BLAKE2b-256 | 40433c8828e69093c9a004d83a8d546256631b1516468c4c25a8e0e47778d438 |
Close
Hashes for mkdocs_material_adr-1.0.1a1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5fa8181fd8a60a9828961b88f890d803ecfcb6a1ee0a9d1d46eae7998feec395 |
|
MD5 | 4d1b210fefa79541806312bb3b0fac16 |
|
BLAKE2b-256 | c57281822019c0224a1a137b23263eae4c43b7d7f307d1a7934ffa751b240abd |