mkdocs.yml


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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

# Site parameters
site_name: A Debian Administration Effort

# Theme configuration
# See https://www.mkdocs.org/user-guide/choosing-your-theme/
#     https://squidfunk.github.io/mkdocs-material/
theme:
  # Theme name
  name: material

  # Logo
  logo: https://fluxo.info/images/fluxo.png

  # Do not use external fonts
  # Useful for offline operation, GDPR compliance and privacy in general
  # See https://squidfunk.github.io/mkdocs-material/setup/changing-the-fonts/#autoloading
  #
  # This option was superseded by the privacy plugin:
  # https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#built-in-privacy-plugin
  #font: false

# Plugins
# https://www.mkdocs.org/dev-guide/plugins/
plugins:
  # Search
  # See https://www.mkdocs.org/user-guide/configuration/#search
  #     https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/
  search: {}

  # Note that this might not be available in the mkdocs-material package from
  # Debian bookworm (as of 2024-08-23)
  privacy: {}

# Markdown extensions
# See https://www.mkdocs.org/user-guide/configuration/#markdown_extensions
#     https://squidfunk.github.io/mkdocs-material/setup/extensions/
markdown_extensions:
  # Footnotes
  # https://squidfunk.github.io/mkdocs-material/reference/footnotes/
  footnotes: {}

  # Tasklist handling
  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#tasklist
  pymdownx.tasklist:
    custom_checkbox: true

  # SuperFences
  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#superfences
  pymdownx.superfences:
    custom_fences:
      - name: mermaid
        class: mermaid
        format: !!python/name:pymdownx.superfences.fence_code_format

  # Table of Contents configuration
  # See https://www.mkdocs.org/user-guide/configuration/#markdown_extensions
  #     https://www.mkdocs.org/user-guide/writing-your-docs/#linking-to-pages
  toc:
    permalink: true

  # Attribute Lists
  # Needed by proper image handling
  # https://squidfunk.github.io/mkdocs-material/reference/images/
  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#attribute-lists
  attr_list: {}

  # Markdown in HTML
  # Needed by proper image handling
  # https://squidfunk.github.io/mkdocs-material/reference/images/
  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#markdown-in-html
  md_in_html: {}

# Copyright notice
copyright: Copyleft &copy; 2024 Fluxo Group. See LICENSE for details.

# Extra template parameters
# https://www.mkdocs.org/user-guide/configuration/#extra
extra:
  generator: false

# Navigation
# https://www.mkdocs.org/user-guide/writing-your-docs/#configure-pages-and-navigation
nav:
  - README.md
  - Installation:
    - installation/README.md
  - Maintenance:
    - maintenance/README.md
    - maintenance/offline.md
  - Packaging:
    - packaging/README.md
    - packaging/basics.md
    - packaging/env.md
    - packaging/checking.md
    - packaging/building.md
    - packaging/testing.md
    - packaging/repositories.md
    - packaging/cross.md
    - packaging/custom/python.md
    - packaging/custom/ruby.md
    - packaging/custom/leap.md
    - packaging/itp.md
    - packaging/references.md
  - todo.md