mirror of
https://github.com/ClementTsang/bottom
synced 2024-11-10 06:34:16 +00:00
183 lines
4.9 KiB
YAML
183 lines
4.9 KiB
YAML
# 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/main/docs/content/"
|
|
copyright: Copyright © 2019 - 2024 Clement Tsang
|
|
|
|
# Theming
|
|
theme:
|
|
name: material
|
|
font:
|
|
code: IBM Plex Mono
|
|
features:
|
|
- content.action.edit
|
|
- navigation.expand
|
|
- navigation.footer
|
|
- navigation.indexes
|
|
- navigation.instant
|
|
- navigation.instant.progress
|
|
- navigation.sections
|
|
- navigation.tabs
|
|
- navigation.top
|
|
- search.highlight
|
|
- search.suggest
|
|
- toc.integrate
|
|
- toc.follow
|
|
icon:
|
|
edit: material/pencil
|
|
palette:
|
|
# Palette toggle for automatic mode
|
|
- media: "(prefers-color-scheme)"
|
|
scheme: default
|
|
toggle:
|
|
icon: material/brightness-auto
|
|
name: Switch to light mode
|
|
# Light mode
|
|
- media: "(prefers-color-scheme: light)"
|
|
primary: indigo
|
|
accent: indigo
|
|
toggle:
|
|
icon: material/weather-sunny
|
|
name: Switch to dark mode
|
|
# Dark mode
|
|
- media: "(prefers-color-scheme: dark)"
|
|
scheme: slate
|
|
primary: black
|
|
accent: indigo
|
|
toggle:
|
|
icon: material/weather-night
|
|
name: Switch to system preference
|
|
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
|
|
- git-revision-date-localized:
|
|
type: date
|
|
- privacy
|
|
|
|
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 Options": configuration/command-line-options.md
|
|
- "Config File":
|
|
- configuration/config-file/index.md
|
|
- "Flags": configuration/config-file/flags.md
|
|
- "Styling": configuration/config-file/styling.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
|