Skip to main content

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.

Features

ADR Headers

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

Alt text

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs_material_adr-1.0.0.tar.gz (7.1 kB view hashes)

Uploaded Source

Built Distribution

mkdocs_material_adr-1.0.0-py3-none-any.whl (8.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page