From 97df47644d3f51239b5dc5e5625beabdd1ff6ff9 Mon Sep 17 00:00:00 2001 From: Ralf Gommers Date: Sat, 29 Jun 2024 09:21:50 +0200 Subject: [PATCH] Improve html theme: dark mode, nicer color scheme, icons for github/license, etc. --- mkdocs.yml | 36 +++++++++++++++++++++++++++++++++++- 1 file changed, 35 insertions(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 74a18a5bb..374b03e39 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,17 +1,44 @@ site_name: OpenBLAS site_url: https://openblas.net/docs/ +repo_url: https://github.com/OpenMathLib/OpenBLAS +copyright: Copyright © 2012- OpenBLAS contributors + theme: name: material logo: logo.svg favicon: logo.svg + features: + - header.autohide palette: - primary: grey + # Palette toggle for dark mode + - scheme: slate + primary: blue grey + toggle: + icon: material/brightness-4 + name: Switch to light mode + + # Palette toggle for light mode + - scheme: default + primary: blue grey + toggle: + icon: material/brightness-7 + name: Switch to dark mode + +plugins: + - search + - git-revision-date-localized: + enable_creation_date: true + markdown_extensions: - admonition - pymdownx.details - pymdownx.superfences + - footnotes + - pymdownx.tabbed: + alternate_style: true - toc: toc_depth: 4 + nav: - index.md - install.md @@ -23,3 +50,10 @@ nav: - ci.md - about.md - faq.md + +extra: + social: + - icon: fontawesome/brands/github + link: https://github.com/OpenMathLib/OpenBLAS + - icon: material/license + link: https://github.com/OpenMathLib/OpenBLAS/LICENSE