diff options
| author | Clement Tsang <34804052+ClementTsang@users.noreply.github.com> | 2021-06-20 22:40:58 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-06-21 01:40:58 -0400 |
| commit | 06071d5abfb8b6715768e8bbb1236be49c02cf46 (patch) | |
| tree | 9a53c083eeabfce6d9f934598de97f787acf7123 /docs/content/usage/widgets/memory.md | |
| parent | a6f6df9ff833c0763e1ba191ff9d22a74bdb1fae (diff) | |
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.
Diffstat (limited to 'docs/content/usage/widgets/memory.md')
| -rw-r--r-- | docs/content/usage/widgets/memory.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/content/usage/widgets/memory.md b/docs/content/usage/widgets/memory.md new file mode 100644 index 00000000..180b4b64 --- /dev/null +++ b/docs/content/usage/widgets/memory.md @@ -0,0 +1,30 @@ +# Memory Widget + +The memory widget provides a visual representation of RAM and swap usage over time. + +<figure> + <img src="../../../assets/screenshots/memory.png" alt="A picture of an expanded memory widget."/> +</figure> + +## Features + +The legend displays the current usage in terms of percentage and actual usage. +If the total RAM or swap available is 0, then it is automatically hidden from the legend and graph. + +One can also adjust the displayed time range through either the keyboard or mouse, with a range of 30s to 600s. + +## Key bindings + +Note that key bindings are generally case-sensitive. + +| Binding | Action | +| --------- | --------------------------------------- | +| ++plus++ | Zoom in on chart (decrease time range) | +| ++minus++ | Zoom out on chart (increase time range) | +| ++equal++ | Reset zoom | + +## Mouse bindings + +| Binding | Action | +| ------------ | -------------------------------------------------------------- | +| ++"Scroll"++ | Scrolling up or down zooms in or out of the graph respectively | |