Mirrors/bottom
2
0
Fork 0
mirror of https://github.com/ClementTsang/bottom synced 2024-11-27 14:40:43 +00:00
Code Issues Projects Releases Packages Wiki Activity
bottom/docs/content/index.md

40 lines
1.6 KiB
Markdown
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
---
title: Home
---
# `bottom`
docs: add a quick blurb on doc site of what bottom is (#875)
2022-11-07 07:44:30 +00:00
A customizable cross-platform graphical process/system monitor for the terminal, supporting Linux, macOS, and Windows. Inspired by other tools like [gtop](https://github.com/aksakalli/gtop), [gotop](https://github.com/xxxserxxx/gotop), and [htop](https://github.com/htop-dev/htop).
---
docs: update a line in the docs
2021-07-22 18:39:14 +00:00
This site serves as extended documentation for bottom alongside the [`README.md`](https://github.com/ClementTsang/bottom#readme).
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
!!! Warning
ci: Use commit hash for some actions to pin them (#641) Pins some actions using a specific commit hash.
2021-12-22 22:29:50 +00:00
Some areas of this site are still in progress and may be missing details. Feel free to suggest/contribute changes!
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
## Installation
!!! Tip
docs: fix dead link (#771)
2022-07-26 18:08:03 +00:00
It is a good idea to first check out the [Support](./support/official) page to see if your system is officially supported!
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
!!! Tip
docs: change contribution wording in docs page a bit (#614) Tiny wording changes.
2021-11-27 11:41:54 +00:00
If you're facing some issues during/after installation, check out the [Troubleshooting](./troubleshooting) page for some common problems and solutions.
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
To install bottom, refer to [the installation section of the `README.md`](https://github.com/ClementTsang/bottom#installation),
which contains a list of all the installation methods.
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
## Usage and configuration
You can refer to the [usage](./usage/general-usage/) pages on how to use bottom (e.g. keybinds, some features, a general overview of what each widget does).
To configure bottom, refer to the [configuration](./configuration/command-line-flags/) pages (e.g. how it behaves, how it looks).
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: change contribution wording in docs page a bit (#614) Tiny wording changes.
2021-11-27 11:41:54 +00:00
New contributors are always welcome! See the [contribution](./contribution/issues-and-pull-requests/) section for how to contribute to
bottom, whether it be filing issues, writing documentation, creating pull requests, etc.
Reference in a new issue Copy permalink