Mirrors/bottom
2
0
Fork 0
mirror of https://github.com/ClementTsang/bottom synced 2024-11-23 20:53:07 +00:00
Code Issues Projects Releases Packages Wiki Activity
bottom/docs/content/index.md

30 lines
1 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: Change wording in main page for one line
2021-06-21 15:31:21 +00:00
This site serves as documentation for bottom, as well as an extension to 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
Some areas of this documentation is still in progress, and should get better in time. Feel free to suggest/contribute changes!
## Installation
!!! Tip
It's probably a good idea to first check out the [Support](./support) page to see if your system is officially supported!
!!! Tip
If you're facing some issues during/after installation, check the [Troubleshooting](./troubleshooting) page for some common problems and solutions.
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.
## Contribution
New contributors are always welcome! See the [contribution](./contribution/issues-and-pull-requests/) section for how to help contribute to
bottom, whether it be filing issues or creating pull requests.
Reference in a new issue Copy permalink