mbl-library-template-kmp/mkdocs.yml at development · MobileByteLabs/mbl-library-template-kmp · GitHub

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
83
84
85
86
87
88
89
site_name: TEMPLATE_LIBRARY_NAME
site_description: TEMPLATE_DESCRIPTION
site_url: https://TEMPLATE_ORG.github.io/TEMPLATE_REPO/
repo_url: https://github.com/TEMPLATE_ORG/TEMPLATE_REPO
repo_name: TEMPLATE_ORG/TEMPLATE_REPO
edit_uri: edit/development/docs/

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.action.edit

extra_css:
  - stylesheets/mbs-brand.css

# Wiki-only constructs (consumed by sync-docs-to-wiki.yml). Exclude from
# the mkdocs site since they don't belong in the canonical nav.
# Home.md is wiki's home page (basename-indexed). mkdocs needs index.md
# for the root URL — same content lives in both files; exclude Home.md
# here to avoid a redundant /Home/ page in the rendered site.
exclude_docs: |
  _Sidebar.md
  Home.md

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - toc:
      permalink: true

plugins:
  - search

validation:
  links:
    not_found: info
    absolute_links: ignore
    unrecognized_links: info

# Minimal starter nav. Extend per your library's sections. Each entry maps
# to a markdown file under docs/. The headings below mirror the worker-kmp
# example: Getting started / Features / Platform support / Operations /
# Release. Drop the ones you don't need.
nav:
  - Home: index.md
  - Contributing:
      - Docs guide (template): DEVELOPMENT-TEMPLATE.md
      - Docs guide (project): DEVELOPMENT.md
  # - Getting started:
  #     - Installation: getting-started/installation.md
  #     - Quick start: getting-started/quick-start.md
  # - Features:
  #     - First capability: features/first-capability.md
  # - Platform support:
  #     - Android: platform-support/android.md
  #     - iOS: platform-support/ios.md
  # - Operations:
  #     - Performance: operations/performance.md
  # - Release:
  #     - Release process: release/release-process.md