Repository navigation
Expand file tree
/
Copy pathmkdocs.yml
More file actions
82 lines (73 loc) · 2.21 KB
/
Copy pathmkdocs.yml
File metadata and controls
82 lines (73 loc) · 2.21 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
# MkDocs configuration for GakuNin RDM Developer Environment 2027
# Site documentation built from docs/**/*.md
site_name: "GakuNin RDM Developer Environment 2027 / 開発環境 2027 版"
docs_dir: docs
site_dir: site
# Theme configuration
theme:
name: material
palette:
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/brightness-4
name: Switch to system theme
features:
- navigation.tabs
- navigation.sections
- toc.scrollspy
- content.code.copy
icon:
repo: fontawesome/brands/github
# Markdown extensions
markdown_extensions:
- admonition
- attr_list
- md_in_html
- tables
- toc:
permalink: true
slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
case: lower
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- name: toon
class: toon
format: !!python/name:pymdownx.superfences.fence_code_format
# Navigation: generated from the docs/ tree (each folder's README.md is its index page).
# Extra JavaScript for Mermaid diagrams
extra_javascript:
- assets/mermaid.min.js
- assets/mermaid-init.js
# Extra CSS (optional, for custom styling)
extra_css:
- assets/stylesheets/extra.css
# Repository configuration
repo_url: https://github.com/rcosdp/RDM-developer-guide
edit_uri: edit/develop/docs/
# Plugins (if needed in future)
plugins:
- search
# Link validation. File existence is enforced by tools/docs_check.py (strict, GitHub-style);
# MkDocs cannot see files outside docs/ (root README.md, site/), and its anchor slugs differ
# from GitHub's for Japanese headings, so those two checks are informational here.
validation:
nav:
omitted_files: info
links:
not_found: info
anchors: info
unrecognized_links: info # legacy guide text keeps its original relative links