summaryrefslogtreecommitdiffstats
path: root/docs/mkdocs.yml
blob: f59e9ddc4f208338524b67beb8d670b258a112d7 (plain)
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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
# Site information
site_name: bottom
site_author: Clement Tsang
site_url: https://clementtsang.github.io/bottom
site_description: >-
  A customizable cross-platform graphical process/system monitor for the terminal. Supports Linux, macOS, and Windows.
docs_dir: "content/"
# Project information
repo_name: ClementTsang/bottom
repo_url: https://github.com/ClementTsang/bottom
edit_uri: "edit/master/docs/content/"

# Theming
theme:
  name: material
  features:
    - navigation.tabs
    - navigation.top
    - navigation.expand
    - navigation.instant
    - navigation.sections
    - toc.integrate
    - search.suggest
    - search.highlight
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  custom_dir: "content/overrides"
extra_css:
  - stylesheets/extra.css

# Extensions
markdown_extensions:
  - admonition
  - attr_list
  - toc:
      anchorlink: true
  - pymdownx.inlinehilite
  - pymdownx.keys:
      # Override to make it case-sensitive
      key_map:
        {
          "a": "a",
          "b": "b",
          "c": "c",
          "d": "d",
          "e": "e",
          "f": "f",
          "g": "g",
          "h": "h",
          "i": "i",
          "j": "j",
          "k": "k",
          "l": "l",
          "m": "m",
          "n": "n",
          "o": "o",
          "p": "p",
          "q": "q",
          "r": "r",
          "s": "s",
          "t": "t",
          "u": "u",
          "v": "v",
          "w": "w",
          "x": "x",
          "y": "y",
          "z": "z",
          "A": "A",
          "B": "B",
          "C": "C",
          "D": "D",
          "E": "E",
          "F": "F",
          "G": "G",
          "H": "H",
          "I": "I",
          "J": "J",
          "K": "K",
          "L": "L",
          "M": "M",
          "N": "N",
          "O": "O",
          "P": "P",
          "Q": "Q",
          "R": "R",
          "S": "S",
          "T": "T",
          "U": "U",
          "V": "V",
          "W": "W",
          "X": "X",
          "Y": "Y",
          "Z": "Z",
        }
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.superfences
  - mdx_truly_sane_lists # See https://github.com/mkdocs/mkdocs/issues/545#issuecomment-522196661
  - pymdownx.tabbed:
      alternate_style: true

plugins:
  - tags
  - search
  - mike:
      canonical_version: stable

extra:
  # Versioning
  version:
    provider: mike
    default: stable

# Navigation
nav:
  - "Home": index.md
  - "Support":
      - "Official Support": support/official.md
      - "Unofficial Support": support/unofficial.md
  - "Usage":
      - "General Usage": usage/general-usage.md
      - "Basic Mode": usage/basic-mode.md
      - "Widgets":
          - "CPU Widget": usage/widgets/cpu.md
          - "Memory Widget": usage/widgets/memory.md
          - "Network Widget": usage/widgets/network.md
          - "Process Widget": usage/widgets/process.md
          - "Disk Widget": usage/widgets/disk.md
          - "Temperature Widget": usage/widgets/temperature.md
          - "Battery Widget": usage/widgets/battery.md
  - "Configuration":
      - "Command-line Flags": configuration/command-line-flags.md
      - "Config File":
          - "Default Config": configuration/config-file/default-config.md
          - "Flags": configuration/config-file/flags.md
          - "Theming": configuration/config-file/theming.md
          - "Layout": configuration/config-file/layout.md
          - "Data Filtering": configuration/config-file/data-filtering.md
          - "Processes": configuration/config-file/processes.md
  - "Contribution":
      - "Issues, Pull Requests, and Discussions": contribution/issues-and-pull-requests.md
      - "Documentation": contribution/documentation.md
      - "Packaging and Distribution": contribution/packaging-and-distribution.md
      - "Development":
          - "Development Environment": contribution/development/dev_env.md
          - "Testing": contribution/development/testing.md
          - "Logging": contribution/development/logging.md
          - "Build Process": contribution/development/build_process.md
          - "Deploy Process": contribution/development/deploy_process.md
  - "Troubleshooting": troubleshooting.md