site_name: docs.kcp.io repo_url: https://github.com/kcp-dev/kcp repo_name: kcp-dev/kcp site_url: https://docs.kcp.io/kcp/ # Site content docs_dir: "content" # Where to generate site_dir: "generated" theme: name: material language: en # Common files such as images, stylesheets, theme overrides custom_dir: "overrides" features: # Enable navigation section index pages, so we don't see Concepts > Concepts - navigation.indexes # Enable navigation tabs so we can group content by persona - navigation.tabs # Expand subsections by default for better visibility of content - navigation.expand # Show "back to top" button - navigation.top # Enable a copy button in code blocks - content.code.copy # Enable annotations on specific lines in code blocks - content.code.annotate logo: logo.svg favicon: favicons/favicon.ico palette: # Palette toggle for automatic mode - media: "(prefers-color-scheme)" toggle: icon: material/brightness-auto name: Switch to light mode # Palette toggle for light mode - media: "(prefers-color-scheme: light)" scheme: default primary: white toggle: icon: material/brightness-7 name: Switch to dark mode # Palette toggle for dark mode - media: "(prefers-color-scheme: dark)" scheme: slate primary: black toggle: icon: material/brightness-4 name: Switch to system preference extra_css: - stylesheets/version_banner.css - stylesheets/crd.css extra_javascript: - scripts/version_banner.js extra: version: # Enable mike for multi-version selection provider: mike social: - icon: fontawesome/brands/github link: https://github.com/kcp-dev/kcp - icon: fontawesome/brands/slack link: https://kubernetes.slack.com/archives/C021U8WSAFK - icon: fontawesome/brands/youtube link: https://www.youtube.com/@kcp-dev plugins: # https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin # Greater control over how navigation links are shown - awesome-pages # Docs site search - search # Use Jinja macros in .md files - macros: include_dir: "overrides" module_name: "main" # Configure multiple language support - i18n: docs_structure: suffix fallback_to_default: true languages: - build: true default: true locale: en name: English reconfigure_material: true reconfigure_search: true # Configure multi-version plugin - mike: alias_type: redirect # Click images to enlarge them in a lightbox - glightbox markdown_extensions: # Code block highlighting - pymdownx.highlight: # Allows linking directly to specific lines in code blocks anchor_linenums: true - pymdownx.superfences: custom_fences: - name: mermaid class: mermaid format: !!python/name:pymdownx.superfences.fence_code_format # Inline code block highlighting - pymdownx.inlinehilite # Lets you embed content from another file - pymdownx.snippets # Arbitrary nesting of code/content blocks inside each other - pymdownx.superfences # Enable note/warning/etc. callouts - admonition # Add permalinks to all headlines - toc: permalink: true # Live reload if any of these change when running 'mkdocs serve' watch: - mkdocs.yml - content - overrides