mkdocs.yml
author Da Risk <da_risk@geekorum.com>
Mon, 05 May 2025 03:37:00 -0400
changeset 80 2474591aa280
parent 75 bcfc8238b4f6
child 84 f1e51fe391c2
permissions -rw-r--r--
ui:common: add more kdocs
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
75
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     1
# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     2
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     3
site_name: AboutOss
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     4
copyright: 'Copyright &copy; 2025 Frédéric Barthéléry'
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     5
repo_url: https://github.com/fbarthelery/AboutOss
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     6
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     7
theme:
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     8
  name: material
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     9
  palette:
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    10
    # Palette toggle for automatic mode
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    11
    - media: "(prefers-color-scheme)"
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    12
      toggle:
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    13
        icon: material/brightness-auto
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    14
        name: Switch to light mode
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    15
    - media: "(prefers-color-scheme: light)"
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    16
      scheme: default
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    17
      toggle:
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    18
        icon: material/brightness-7
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    19
        name: Switch to dark mode
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    20
    - media: '(prefers-color-scheme: dark)'
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    21
      scheme: slate
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    22
      toggle:
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    23
        icon: material/brightness-4
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    24
        name: Switch to light mode
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    25
  icon:
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    26
    repo: fontawesome/brands/github
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    27
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    28
  features:
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    29
    - content.code.copy
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    30
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    31
markdown_extensions:
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    32
  - pymdownx.highlight:
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    33
      line_spans: __span
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    34
      pygments_lang_class: true
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    35
  - pymdownx.inlinehilite
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    36
  - pymdownx.snippets
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    37
  - pymdownx.superfences
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    38
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    39
nav:
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    40
  - Home: index.md
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    41
  - API: api/index.html
bcfc8238b4f6 docs: start documentation using mkdocs
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    42
  - "Discussions ⏏": https://github.com/fbarthelery/AboutOss/discussions