Metadata-Version: 2.1
Name: mkdocs-material-adr
Version: 1.0.0
Summary: 
Author: jeanloup.monnier
Author-email: jean-loup.monnier@spikeelabs.fr
Requires-Python: >=3.9,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Description-Content-Type: text/markdown

# ADR for MkDocs's Material Theme

[ADR](https://lyz-code.github.io/blue-book/adr/) are short text documents that captures an important architectural decision made along with its context and consequences.

## Features

### ADR Headers
Information about the ADR are displayed in a header
Define information about the ADR in the frontmatter.

![Alt text](docs/assets/header.png)


```md
---
    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

```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

