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

155 lines
4 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
docs: update edit link for doc site
2021-08-04 15:49:55 +00:00
edit_uri: "edit/master/docs/content/"
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:
- 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
- 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
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:
# 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
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: 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
default: nightly
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
- "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
- "Basic Mode": usage/basic-mode.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":
- "Command-line Flags": configuration/command-line-flags.md
- "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: 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
- "Development": contribution/development.md
- "Packaging and Distribution": contribution/packaging-and-distribution.md
- "Troubleshooting": troubleshooting.md
Reference in a new issue Copy permalink