diff --git a/README.md b/README.md index 819a1a3..d68ecc9 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ -![Ignis logo](docs/assets/logo/ignis-logo-dark.svg#gh-dark-mode-only) -![Ignis logo](docs/assets/logo/ignis-logo-light.svg#gh-light-mode-only) +ignis [![CI](https://github.com/thd-spatial-ai/ignis/actions/workflows/ci.yml/badge.svg)](https://github.com/thd-spatial-ai/ignis/actions/workflows/ci.yml)   [![MkDocs](https://github.com/thd-spatial-ai/ignis/actions/workflows/docs.yml/badge.svg)](https://thd-spatial-ai.github.io/ignis)   [![Go](https://github.com/THD-Spatial-AI/ignis/actions/workflows/go.yml/badge.svg)](https://github.com/THD-Spatial-AI/ignis/actions/workflows/go.yml)   [![codecov](https://codecov.io/gh/THD-Spatial-AI/ignis/graph/badge.svg?token=CTUZED1ELJ)](https://codecov.io/gh/THD-Spatial-AI/ignis)   [![GitHub release](https://img.shields.io/github/v/release/thd-spatial-ai/ignis?include_prereleases&label=release&logo=github)](https://github.com/thd-spatial-ai/ignis/releases) diff --git a/docs/assets/logo/favicon.ico b/docs/assets/logo/favicon.ico new file mode 100644 index 0000000..e0491d4 Binary files /dev/null and b/docs/assets/logo/favicon.ico differ diff --git a/docs/assets/logo/ignis-icon-light.svg b/docs/assets/logo/ignis-icon-light.svg deleted file mode 100644 index 8d0be48..0000000 --- a/docs/assets/logo/ignis-icon-light.svg +++ /dev/null @@ -1,63 +0,0 @@ - - - - diff --git a/docs/assets/logo/ignis-lockup-ember-dark-outline.svg b/docs/assets/logo/ignis-lockup-ember-dark-outline.svg new file mode 100644 index 0000000..9a98902 --- /dev/null +++ b/docs/assets/logo/ignis-lockup-ember-dark-outline.svg @@ -0,0 +1 @@ +ignis diff --git a/docs/assets/logo/ignis-lockup-ember-outline.svg b/docs/assets/logo/ignis-lockup-ember-outline.svg new file mode 100644 index 0000000..eaaf5bc --- /dev/null +++ b/docs/assets/logo/ignis-lockup-ember-outline.svg @@ -0,0 +1 @@ +ignis diff --git a/docs/assets/logo/ignis-logo-dark.svg b/docs/assets/logo/ignis-logo-dark.svg deleted file mode 100644 index d2469a7..0000000 --- a/docs/assets/logo/ignis-logo-dark.svg +++ /dev/null @@ -1,72 +0,0 @@ - - - -ignis diff --git a/docs/assets/logo/ignis-logo-light.svg b/docs/assets/logo/ignis-logo-light.svg deleted file mode 100644 index f3691d8..0000000 --- a/docs/assets/logo/ignis-logo-light.svg +++ /dev/null @@ -1,72 +0,0 @@ - - - -ignis diff --git a/docs/index.md b/docs/index.md index 488d7ec..48dc744 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,9 +2,6 @@ audience: developer --- -![Ignis logo](assets/logo/ignis-logo-dark.svg#gh-dark-mode-only) -![Ignis logo](assets/logo/ignis-logo-light.svg#gh-light-mode-only) - [![CI](https://github.com/thd-spatial-ai/ignis/actions/workflows/ci.yml/badge.svg)](https://github.com/thd-spatial-ai/ignis/actions/workflows/ci.yml)   [![MkDocs](https://github.com/thd-spatial-ai/ignis/actions/workflows/docs.yml/badge.svg)](https://thd-spatial-ai.github.io/ignis)   [![codecov](https://codecov.io/gh/THD-Spatial-AI/ignis/graph/badge.svg?token=CTUZED1ELJ)](https://codecov.io/gh/THD-Spatial-AI/ignis)   [![GitHub release](https://img.shields.io/github/v/release/thd-spatial-ai/ignis?include_prereleases&label=release&logo=github)](https://github.com/thd-spatial-ai/ignis/releases) Go microservice implementing the ISO 13790 annual heating energy demand calculation pipeline, validated against the [TABULA](https://episcope.eu/building-typology/tabula-webtool/) European building typology database. Data source: IEE Projects TABULA + EPISCOPE (www.episcope.eu). diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css new file mode 100644 index 0000000..a26a377 --- /dev/null +++ b/docs/stylesheets/extra.css @@ -0,0 +1,31 @@ +/* Spatial AI brand colours, with the ignis ember accent. */ +[data-md-color-scheme="default"] { + --md-primary-fg-color: #16191c; + --md-primary-fg-color--light: #2b2f33; + --md-primary-fg-color--dark: #0e1012; + --md-accent-fg-color: #d2461f; + /* Brand ember is 4.16:1 on the ground colour; this shade reaches the 4.5:1 AA minimum for text. */ + --md-typeset-a-color: #c7421d; + --md-default-bg-color: #f7f5f1; +} + +[data-md-color-scheme="slate"] { + --md-primary-fg-color: #16191c; + --md-primary-fg-color--light: #2b2f33; + --md-primary-fg-color--dark: #0e1012; + --md-accent-fg-color: #ff6b3d; + --md-typeset-a-color: #ff6b3d; + --md-default-bg-color: #16191c; +} + +/* The header logo is the lockup, which carries the project name, so the text site name is hidden + where the logo shows. Below 76.25em Material moves the logo into the drawer and the name stays. */ +.md-header__button.md-logo img { + height: 2rem; +} + +@media screen and (min-width: 76.25em) { + .md-header__title .md-header__topic:first-child { + visibility: hidden; + } +} diff --git a/mkdocs.yml b/mkdocs.yml index fafe4c8..9ee2884 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -13,6 +13,9 @@ edit_uri: edit/main/docs/ # Theme configuration theme: name: material + # The header is brand ink (#16191c) in both schemes, the background the -dark lockup is drawn for. + logo: assets/logo/ignis-lockup-ember-dark-outline.svg + favicon: assets/logo/favicon.ico features: - announce.dismiss - content.action.edit @@ -38,20 +41,22 @@ theme: language: en palette: - media: "(prefers-color-scheme)" + primary: custom + accent: custom toggle: icon: material/link name: Switch to light mode - media: "(prefers-color-scheme: light)" scheme: default - primary: indigo - accent: indigo + primary: custom + accent: custom toggle: icon: material/toggle-switch name: Switch to dark mode - media: "(prefers-color-scheme: dark)" scheme: slate - primary: black - accent: indigo + primary: custom + accent: custom toggle: icon: material/toggle-switch-off name: Switch to system preference @@ -59,6 +64,9 @@ theme: text: Roboto code: Roboto Mono +extra_css: + - stylesheets/extra.css + # Plugins plugins: - search: