Add mkdocs.yml

This commit is contained in:
support 2025-11-02 02:25:34 +00:00
parent f593bfedc8
commit 8ed8db1a9e

58
mkdocs.yml Normal file
View file

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