From 8ed8db1a9e9d8e46e800c1471d3e03b3d536ab11 Mon Sep 17 00:00:00 2001 From: support Date: Sun, 2 Nov 2025 02:25:34 +0000 Subject: [PATCH] Add mkdocs.yml --- mkdocs.yml | 58 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 mkdocs.yml diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..b012487 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,58 @@ +site_name: KH3 Noticeboard +site_description: Centralized view of current projects, updates, and announcements from KH3 Group. +site_url: https://docs.kh3group.com + +repo_name: kh3group/kh3_notice_board +repo_url: https://gitea.kh3group.com/kh3group/kh3_notice_board + +theme: + name: material + features: + - navigation.instant # Faster navigation + - navigation.sections # Grouped sidebar + - content.code.copy # Copy button on code blocks + - toc.integrate # Integrated table of contents + - search.highlight + - search.share + palette: + # Light and dark mode (optional) + - scheme: default + primary: blue grey + accent: indigo + - scheme: slate + primary: blue grey + accent: indigo + toggle: + icon: material/weather-night + name: Switch to dark mode + +nav: + - Home: index.md + - Noticeboard: noticeboard.md + - Files: + - Noticeboard Data: _files/noticeboard_data.json + +markdown_extensions: + - admonition + - attr_list + - toc: + permalink: true + - pymdownx.details + - pymdownx.superfences + - pymdownx.tasklist: + custom_checkbox: true + +extra_css: + - stylesheets/noticeboard.css + +plugins: + - search + - git-revision-date-localized: + fallback_to_build_date: true + # Optional, but very useful if you ever add diagrams or charts + - mermaid2 + +# Make sure MkDocs serves static JSON files under _files/ +extra: + static: + - _files