Files
brianmcgee 2f012c6cfb docs: restyle MkDocs Material to match docs.clan.lol aesthetic
Align the data-mesher docs visual identity with docs.clan.lol by
overriding the Material theme's colour palette, typography, and
component styling.

When the new docs framework in clan-core becomes portable we can switch to that.

- Switch from Roboto/Fira Code to Mona Sans with system monospace
  fallback for code
- Override light and dark mode palettes to match clan-site's colour
  scheme (oklch values converted to hex for dark mode)
- Style admonitions with clan-site's pastel backgrounds and 4px left
  border in both light and dark modes
- Add white/dark content area with border-radius and border to
  distinguish from page chrome
- Update homepage hero button and heading styles
- Fix docs.nix source path (was resolving to nix/ instead of repo root)
2026-04-14 17:10:20 +01:00

116 lines
2.7 KiB
YAML

# Project info
site_name: Data Mesher
site_url: https://data-mesher.docs.clan.lol
site_description: >-
An eventually consistent, decentralised data service for peer to peer mesh networks.
# Repository
repo_name: clan/data-mesher
repo_url: https://git.clan.lol/clan/data-mesher
# Copyright
#copyright: >-
# Content on this site is licensed under a <a href="https://creativecommons.org/licenses/by-sa/4.0/">Creative Commons
# Attribution-ShareAlike 4.0 International license</a>.
validation:
omitted_files: warn
absolute_links: warn
unrecognized_links: warn
# Configuration
docs_dir: site
site_dir: out
nav:
theme:
name: material
custom_dir: overrides
logo: static/icon.svg
favicon: static/icon.svg
features:
- content.code.annotate
- content.code.copy
- content.tabs.link
- navigation.footer
- navigation.indexes
- navigation.path
- navigation.sections
- navigation.tabs
- navigation.tracking
font: false
palette:
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: custom
accent: custom
toggle:
icon: material/weather-night
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
primary: custom
accent: custom
scheme: slate
toggle:
icon: material/weather-sunny
name: Switch to light mode
extra_css:
- static/extra.css
extra:
version:
provider: mike
social:
- icon: fontawesome/regular/comment
link: https://matrix.to/#/#clan:clan.lol
- icon: fontawesome/brands/git
link: https://git.clan.lol/clan/data-mesher
- icon: fontawesome/brands/github
link: https://github.com/clan-lol/data-mesher
- icon: fontawesome/solid/rss
link: /feed_rss_created.xml
markdown_extensions:
- tables
- admonition
- attr_list
- footnotes
- md_in_html
- def_list
- meta
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.details
- pymdownx.highlight:
use_pygments: true
linenums: true
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets:
base_path: ../.
- pymdownx.keys
- toc:
title: On this page
plugins:
- search
- awesome-nav
- macros
- mike