Mirrors/bottom
2
0
Fork 0
mirror of https://github.com/ClementTsang/bottom synced 2024-11-22 20:23:12 +00:00
Code Issues Projects Releases Packages Wiki Activity
bottom/docs/mkdocs.yml

174 lines
4.7 KiB
YAML
Raw Normal View History

docs: migrate documentation over to mkdocs (#506) A large migration of documentation over to mkdocs, and some rewrites. Some stuff (install information, basic supported systems, contributors, thanks) are still staying in README.md, and CONTRIBUTING.md is essentially duplicated right now. However, stuff like configuration and key/mouse bindings are now moved to mkdocs. Some parts are still a bit WIP - it is definitely not done (documentation never seems to be...). However, it should be "good enough" for now, and I'm much happier working with the documentation in this form than trying to scroll through a giant endless README.md file. It also works much better for adding new documentation.
2021-06-21 05:40:58 +00:00
# Site information
site_name: bottom
site_author: Clement Tsang
docs: revert CFP for now (#633) There were some weird interactions that I'm not sure about (like if you do bottom.pages.dev/asdf/ it infinitely redirects...?), so I'll revert for now.
2021-12-19 20:42:22 +00:00
site_url: https://clementtsang.github.io/bottom
docs: migrate documentation over to mkdocs (#506) A large migration of documentation over to mkdocs, and some rewrites. Some stuff (install information, basic supported systems, contributors, thanks) are still staying in README.md, and CONTRIBUTING.md is essentially duplicated right now. However, stuff like configuration and key/mouse bindings are now moved to mkdocs. Some parts are still a bit WIP - it is definitely not done (documentation never seems to be...). However, it should be "good enough" for now, and I'm much happier working with the documentation in this form than trying to scroll through a giant endless README.md file. It also works much better for adding new documentation.
2021-06-21 05:40:58 +00:00
site_description: >-
docs: update app descriptions (#659) Update app descriptions across the board to be more consistent.
2022-01-20 04:49:11 +00:00
A customizable cross-platform graphical process/system monitor for the terminal. Supports Linux, macOS, and Windows.
docs: migrate documentation over to mkdocs (#506) A large migration of documentation over to mkdocs, and some rewrites. Some stuff (install information, basic supported systems, contributors, thanks) are still staying in README.md, and CONTRIBUTING.md is essentially duplicated right now. However, stuff like configuration and key/mouse bindings are now moved to mkdocs. Some parts are still a bit WIP - it is definitely not done (documentation never seems to be...). However, it should be "good enough" for now, and I'm much happier working with the documentation in this form than trying to scroll through a giant endless README.md file. It also works much better for adding new documentation.
2021-06-21 05:40:58 +00:00
docs_dir: "content/"
# Project information
repo_name: ClementTsang/bottom
repo_url: https://github.com/ClementTsang/bottom
other: master -> main (#1349) * other: master -> main I'm so used to using `main` branch now that it's actually kinda annoying to use `master` for just this repo... so might as well rename it now. * overzealous change * wording * some wording * allow auto-cancel for tests if not main
2023-12-06 05:16:26 +00:00
edit_uri: "edit/main/docs/content/"
add last revision date (#1380)
2024-01-11 08:20:35 +00:00
copyright: Copyright © 2019 - 2024 Clement Tsang
docs: migrate documentation over to mkdocs (#506) A large migration of documentation over to mkdocs, and some rewrites. Some stuff (install information, basic supported systems, contributors, thanks) are still staying in README.md, and CONTRIBUTING.md is essentially duplicated right now. However, stuff like configuration and key/mouse bindings are now moved to mkdocs. Some parts are still a bit WIP - it is definitely not done (documentation never seems to be...). However, it should be "good enough" for now, and I'm much happier working with the documentation in this form than trying to scroll through a giant endless README.md file. It also works much better for adding new documentation.
2021-06-21 05:40:58 +00:00
# Theming
theme:
name: material
features:
add last revision date (#1380)
2024-01-11 08:20:35 +00:00
- content.action.edit
docs: migrate documentation over to mkdocs (#506) A large migration of documentation over to mkdocs, and some rewrites. Some stuff (install information, basic supported systems, contributors, thanks) are still staying in README.md, and CONTRIBUTING.md is essentially duplicated right now. However, stuff like configuration and key/mouse bindings are now moved to mkdocs. Some parts are still a bit WIP - it is definitely not done (documentation never seems to be...). However, it should be "good enough" for now, and I'm much happier working with the documentation in this form than trying to scroll through a giant endless README.md file. It also works much better for adding new documentation.
2021-06-21 05:40:58 +00:00
- navigation.tabs
- navigation.top
- navigation.expand
- navigation.instant
docs: Update mkdocs file layout and config (#642) Updates some settings regarding mkdocs. Main changes: * Separate out support into two separate pages * Move ToC as part of navigation
2021-12-22 23:03:33 +00:00
- navigation.sections
add last revision date (#1380)
2024-01-11 08:20:35 +00:00
- navigation.footer
docs: Update mkdocs file layout and config (#642) Updates some settings regarding mkdocs. Main changes: * Separate out support into two separate pages * Move ToC as part of navigation
2021-12-22 23:03:33 +00:00
- toc.integrate
docs: add some search features to mkdocs config (#704) Enables some search features for the mkdocs config.
2022-04-11 07:54:21 +00:00
- search.suggest
- search.highlight
add last revision date (#1380)
2024-01-11 08:20:35 +00:00
icon:
edit: material/pencil
docs: migrate documentation over to mkdocs (#506) A large migration of documentation over to mkdocs, and some rewrites. Some stuff (install information, basic supported systems, contributors, thanks) are still staying in README.md, and CONTRIBUTING.md is essentially duplicated right now. However, stuff like configuration and key/mouse bindings are now moved to mkdocs. Some parts are still a bit WIP - it is definitely not done (documentation never seems to be...). However, it should be "good enough" for now, and I'm much happier working with the documentation in this form than trying to scroll through a giant endless README.md file. It also works much better for adding new documentation.
2021-06-21 05:40:58 +00:00
palette:
add last revision date (#1380)
2024-01-11 08:20:35 +00:00
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
scheme: default
toggle:
icon: material/brightness-auto
name: Switch to light mode
docs: migrate documentation over to mkdocs (#506) A large migration of documentation over to mkdocs, and some rewrites. Some stuff (install information, basic supported systems, contributors, thanks) are still staying in README.md, and CONTRIBUTING.md is essentially duplicated right now. However, stuff like configuration and key/mouse bindings are now moved to mkdocs. Some parts are still a bit WIP - it is definitely not done (documentation never seems to be...). However, it should be "good enough" for now, and I'm much happier working with the documentation in this form than trying to scroll through a giant endless README.md file. It also works much better for adding new documentation.
2021-06-21 05:40:58 +00:00
# Light mode
- media: "(prefers-color-scheme: light)"
toggle:
add last revision date (#1380)
2024-01-11 08:20:35 +00:00
icon: material/weather-sunny
docs: migrate documentation over to mkdocs (#506) A large migration of documentation over to mkdocs, and some rewrites. Some stuff (install information, basic supported systems, contributors, thanks) are still staying in README.md, and CONTRIBUTING.md is essentially duplicated right now. However, stuff like configuration and key/mouse bindings are now moved to mkdocs. Some parts are still a bit WIP - it is definitely not done (documentation never seems to be...). However, it should be "good enough" for now, and I'm much happier working with the documentation in this form than trying to scroll through a giant endless README.md file. It also works much better for adding new documentation.
2021-06-21 05:40:58 +00:00
name: Switch to dark mode
# Dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
add last revision date (#1380)
2024-01-11 08:20:35 +00:00
icon: material/weather-night
name: Switch to system preference
docs: Update mkdocs file layout and config (#642) Updates some settings regarding mkdocs. Main changes: * Separate out support into two separate pages * Move ToC as part of navigation
2021-12-22 23:03:33 +00:00
custom_dir: "content/overrides"
docs: migrate documentation over to mkdocs (#506) A large migration of documentation over to mkdocs, and some rewrites. Some stuff (install information, basic supported systems, contributors, thanks) are still staying in README.md, and CONTRIBUTING.md is essentially duplicated right now. However, stuff like configuration and key/mouse bindings are now moved to mkdocs. Some parts are still a bit WIP - it is definitely not done (documentation never seems to be...). However, it should be "good enough" for now, and I'm much happier working with the documentation in this form than trying to scroll through a giant endless README.md file. It also works much better for adding new documentation.
2021-06-21 05:40:58 +00:00
extra_css:
- stylesheets/extra.css
# Extensions
markdown_extensions:
- admonition
- attr_list
- toc:
anchorlink: true
- pymdownx.inlinehilite
- pymdownx.keys:
# Override to make it case-sensitive
docs: try switching over to Cloudflare Pages (#632) I would prefer for the project to not be under clementtsang.github.io/bottom, so let's try out CFP.
2021-12-19 20:26:10 +00:00
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",
}
docs: migrate documentation over to mkdocs (#506) A large migration of documentation over to mkdocs, and some rewrites. Some stuff (install information, basic supported systems, contributors, thanks) are still staying in README.md, and CONTRIBUTING.md is essentially duplicated right now. However, stuff like configuration and key/mouse bindings are now moved to mkdocs. Some parts are still a bit WIP - it is definitely not done (documentation never seems to be...). However, it should be "good enough" for now, and I'm much happier working with the documentation in this form than trying to scroll through a giant endless README.md file. It also works much better for adding new documentation.
2021-06-21 05:40:58 +00:00
- pymdownx.details
- pymdownx.highlight
- pymdownx.superfences
- mdx_truly_sane_lists # See https://github.com/mkdocs/mkdocs/issues/545#issuecomment-522196661
docs: Update mkdocs file layout and config (#642) Updates some settings regarding mkdocs. Main changes: * Separate out support into two separate pages * Move ToC as part of navigation
2021-12-22 23:03:33 +00:00
- pymdownx.tabbed:
alternate_style: true
docs: migrate documentation over to mkdocs (#506) A large migration of documentation over to mkdocs, and some rewrites. Some stuff (install information, basic supported systems, contributors, thanks) are still staying in README.md, and CONTRIBUTING.md is essentially duplicated right now. However, stuff like configuration and key/mouse bindings are now moved to mkdocs. Some parts are still a bit WIP - it is definitely not done (documentation never seems to be...). However, it should be "good enough" for now, and I'm much happier working with the documentation in this form than trying to scroll through a giant endless README.md file. It also works much better for adding new documentation.
2021-06-21 05:40:58 +00:00
docs: add some search features to mkdocs config (#704) Enables some search features for the mkdocs config.
2022-04-11 07:54:21 +00:00
plugins:
- tags
- search
docs: bump mike to v2.0.0 (#1318) * bump mike * bump some docs * update some settings and serve script to use mike
2023-11-16 08:17:21 +00:00
- mike:
canonical_version: stable
add last revision date (#1380)
2024-01-11 08:20:35 +00:00
- git-revision-date-localized:
type: date
docs: add some search features to mkdocs config (#704) Enables some search features for the mkdocs config.
2022-04-11 07:54:21 +00:00
docs: Change wording in main page for one line
2021-06-21 15:31:21 +00:00
extra:
docs: Switch to mike for versioning (#521) Switches to mike to add versioning to docs.
2021-06-24 03:34:39 +00:00
# Versioning
version:
provider: mike
docs: make stable docs the default (#958)
2023-01-06 02:08:17 +00:00
default: stable
docs: Change wording in main page for one line
2021-06-21 15:31:21 +00:00
docs: migrate documentation over to mkdocs (#506) A large migration of documentation over to mkdocs, and some rewrites. Some stuff (install information, basic supported systems, contributors, thanks) are still staying in README.md, and CONTRIBUTING.md is essentially duplicated right now. However, stuff like configuration and key/mouse bindings are now moved to mkdocs. Some parts are still a bit WIP - it is definitely not done (documentation never seems to be...). However, it should be "good enough" for now, and I'm much happier working with the documentation in this form than trying to scroll through a giant endless README.md file. It also works much better for adding new documentation.
2021-06-21 05:40:58 +00:00
# Navigation
nav:
- "Home": index.md
docs: Update mkdocs file layout and config (#642) Updates some settings regarding mkdocs. Main changes: * Separate out support into two separate pages * Move ToC as part of navigation
2021-12-22 23:03:33 +00:00
- "Support":
- "Official Support": support/official.md
- "Unofficial Support": support/unofficial.md
docs: migrate documentation over to mkdocs (#506) A large migration of documentation over to mkdocs, and some rewrites. Some stuff (install information, basic supported systems, contributors, thanks) are still staying in README.md, and CONTRIBUTING.md is essentially duplicated right now. However, stuff like configuration and key/mouse bindings are now moved to mkdocs. Some parts are still a bit WIP - it is definitely not done (documentation never seems to be...). However, it should be "good enough" for now, and I'm much happier working with the documentation in this form than trying to scroll through a giant endless README.md file. It also works much better for adding new documentation.
2021-06-21 05:40:58 +00:00
- "Usage":
docs: try switching over to Cloudflare Pages (#632) I would prefer for the project to not be under clementtsang.github.io/bottom, so let's try out CFP.
2021-12-19 20:26:10 +00:00
- "General Usage": usage/general-usage.md
docs: update usage and config, add blurb in home (#876) * docs: update usage and config, add blurb in home * add doc pages to pr template
2022-11-08 04:36:27 +00:00
- "Basic Mode": usage/basic-mode.md
docs: try switching over to Cloudflare Pages (#632) I would prefer for the project to not be under clementtsang.github.io/bottom, so let's try out CFP.
2021-12-19 20:26:10 +00:00
- "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
docs: migrate documentation over to mkdocs (#506) A large migration of documentation over to mkdocs, and some rewrites. Some stuff (install information, basic supported systems, contributors, thanks) are still staying in README.md, and CONTRIBUTING.md is essentially duplicated right now. However, stuff like configuration and key/mouse bindings are now moved to mkdocs. Some parts are still a bit WIP - it is definitely not done (documentation never seems to be...). However, it should be "good enough" for now, and I'm much happier working with the documentation in this form than trying to scroll through a giant endless README.md file. It also works much better for adding new documentation.
2021-06-21 05:40:58 +00:00
- "Configuration":
docs: fix another incorrect heading
2024-01-11 07:30:03 +00:00
- "Command-line Options": configuration/command-line-options.md
docs: migrate documentation over to mkdocs (#506) A large migration of documentation over to mkdocs, and some rewrites. Some stuff (install information, basic supported systems, contributors, thanks) are still staying in README.md, and CONTRIBUTING.md is essentially duplicated right now. However, stuff like configuration and key/mouse bindings are now moved to mkdocs. Some parts are still a bit WIP - it is definitely not done (documentation never seems to be...). However, it should be "good enough" for now, and I'm much happier working with the documentation in this form than trying to scroll through a giant endless README.md file. It also works much better for adding new documentation.
2021-06-21 05:40:58 +00:00
- "Config File":
docs: try switching over to Cloudflare Pages (#632) I would prefer for the project to not be under clementtsang.github.io/bottom, so let's try out CFP.
2021-12-19 20:26:10 +00:00
- "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
docs: update docs with processes column (#1138)
2023-05-07 21:00:55 +00:00
- "Processes": configuration/config-file/processes.md
docs: migrate documentation over to mkdocs (#506) A large migration of documentation over to mkdocs, and some rewrites. Some stuff (install information, basic supported systems, contributors, thanks) are still staying in README.md, and CONTRIBUTING.md is essentially duplicated right now. However, stuff like configuration and key/mouse bindings are now moved to mkdocs. Some parts are still a bit WIP - it is definitely not done (documentation never seems to be...). However, it should be "good enough" for now, and I'm much happier working with the documentation in this form than trying to scroll through a giant endless README.md file. It also works much better for adding new documentation.
2021-06-21 05:40:58 +00:00
- "Contribution":
docs: mention discussions, fix broken link, update mkdocs req (#698) Fixes a broken link, and mention when to use discussions over issues. Also updates mkdocs in the build process due to some broken dependencies.
2022-03-28 01:57:55 +00:00
- "Issues, Pull Requests, and Discussions": contribution/issues-and-pull-requests.md
docs: migrate documentation over to mkdocs (#506) A large migration of documentation over to mkdocs, and some rewrites. Some stuff (install information, basic supported systems, contributors, thanks) are still staying in README.md, and CONTRIBUTING.md is essentially duplicated right now. However, stuff like configuration and key/mouse bindings are now moved to mkdocs. Some parts are still a bit WIP - it is definitely not done (documentation never seems to be...). However, it should be "good enough" for now, and I'm much happier working with the documentation in this form than trying to scroll through a giant endless README.md file. It also works much better for adding new documentation.
2021-06-21 05:40:58 +00:00
- "Documentation": contribution/documentation.md
- "Packaging and Distribution": contribution/packaging-and-distribution.md
docs: adjust dev doc file structure, add build and deploy docs (#804) * docs: add separate section on development * docs: update instructions on writing docs * docs: add build and deploy docs
2022-09-12 08:14:19 +00:00
- "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
docs: migrate documentation over to mkdocs (#506) A large migration of documentation over to mkdocs, and some rewrites. Some stuff (install information, basic supported systems, contributors, thanks) are still staying in README.md, and CONTRIBUTING.md is essentially duplicated right now. However, stuff like configuration and key/mouse bindings are now moved to mkdocs. Some parts are still a bit WIP - it is definitely not done (documentation never seems to be...). However, it should be "good enough" for now, and I'm much happier working with the documentation in this form than trying to scroll through a giant endless README.md file. It also works much better for adding new documentation.
2021-06-21 05:40:58 +00:00
- "Troubleshooting": troubleshooting.md
Reference in a new issue Copy permalink