Deployed 45680da to nightly with MkDocs 1.3.0 and mike 1.1.2

This commit is contained in:
github-actions[bot] authored and ClementTsang committed 2022-05-07 20:38:39 -04:00
1 parent c93e4291fd
commit 47aebcac14
14 files changed
+66 -34

No files matched your search

+37
View File
@@ -0,0 +1,37 @@
# Generated by Cargo
# will have compiled files and executables
/target/
# These are backup files generated by rustfmt
**/*.rs.bk
# Logging
*.log
# Flamegraph stuff
rust-unmangle
*.svg
*.data
*.data.old
# IntelliJ
.idea/
# Heaptrack files
*.zst
# For testing
sample_configs/testing.toml
# Wix
/wix/
# Cargo-deny
deny.toml
# vscode
.vscode
# mkdocs
site/
docs/site
Binary file not shown.

Before

Width:  |  Height:  |  Size: 28 KiB

After

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 28 KiB

After

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 28 KiB

After

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 28 KiB

After

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 28 KiB

After

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 28 KiB

After

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 28 KiB

After

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 28 KiB

After

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 28 KiB

+1 -1
View File
@@ -1 +1 @@
{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"bottom This site serves as extended documentation for bottom alongside the README.md . Warning Some areas of this site are still in progress and may be missing details. Feel free to suggest/contribute changes! Installation Tip It is a good idea to first check out the Support page to see if your system is officially supported! Tip If you're facing some issues during/after installation, check out the Troubleshooting page for some common problems and solutions. To install bottom, refer to the installation section of the README.md , which contains a list of all the installation methods. Contribution New contributors are always welcome! See the contribution section for how to contribute to bottom, whether it be filing issues, writing documentation, creating pull requests, etc.","title":"Home"},{"location":"#bottom","text":"This site serves as extended documentation for bottom alongside the README.md . Warning Some areas of this site are still in progress and may be missing details. Feel free to suggest/contribute changes!","title":"bottom"},{"location":"#installation","text":"Tip It is a good idea to first check out the Support page to see if your system is officially supported! Tip If you're facing some issues during/after installation, check out the Troubleshooting page for some common problems and solutions. To install bottom, refer to the installation section of the README.md , which contains a list of all the installation methods.","title":"Installation"},{"location":"#contribution","text":"New contributors are always welcome! See the contribution section for how to contribute to bottom, whether it be filing issues, writing documentation, creating pull requests, etc.","title":"Contribution"},{"location":"troubleshooting/","text":"Troubleshooting The graph points look broken/strange It's possible that your graphs won't look great out of the box due to the reliance on braille fonts. One example of this is seeing a bunch of missing font characters, caused when the terminal isn't configured properly to render braille fonts. Powershell shown missing braille fonts Another example is when braille is rendered as a block of dots, with the non-coloured dots also appearing. This may look strange for some users, and it is also caused by misconfiguration or missing fonts. Braille fonts rendering as a block of dots One alternative is to use the --dot_marker option to render graph charts using dots instead of the braille characters, which generally seems better supported out of the box, at the expense of looking less intricate: Example using btm --dot_marker Another (better) alternative is to install a font that supports braille fonts, and configure your terminal to use it. For example, installing something like UBraille or Iosevka and ensuring your terminal uses it should work. Installing fonts for Windows Command Prompt/PowerShell Note: I would advise backing up your registry beforehand if you aren't sure what you are doing! Let's say you're installing Iosevka . The steps you can take are: Install the font itself. Open the registry editor, which you can do either by Win+R and opening regedit , or just opening it from the Start Menu. In the registry editor, go to HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Console\\TrueTypeFont Here, add a new String value , and set the Name to a bunch of 0's (e.g. 000 - make sure the name isn't already used), then set the Data to the font name (e.g. Iosevka ). The last entry is the new entry for Iosevka Then, open the Command Prompt/PowerShell, and right click on the top bar, and open Properties : From here, go to Font , and set the font to your new font (e.g. Iosevka ): Why can't I see all my temperature sensors on Windows? This is a known limitation , some sensors may require admin privileges to get sensor data. Why don't I see dual batteries on Windows reported separately? (e.g. Thinkpads) This is a known limitation which seems to be with how batteries are being detected on Windows. Why can't I see all my temperature sensors on WSL? This is a known limitation with WSL. Due to how it works, hosts may not expose their temperature sensors and therefore, temperature sensors might be missing. Why does WSL2 not match Task Manager? This is a known limitation with WSL2. Due to how WSL2 works, the two might not match up in terms of reported data. Why can't I see all my processes/process data on macOS? This is a known limitation , and you may have to run the program with elevated privileges to work around it - for example: sudo btm Please note that you should be certain that you trust any software you grant root privileges. There are measures taken to try to maximize the amount of information obtained without elevated privileges. For example, one can modify the instructions found on the htop wiki on how to run htop without sudLine truncated
{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"bottom This site serves as extended documentation for bottom alongside the README.md . Warning Some areas of this site are still in progress and may be missing details. Feel free to suggest/contribute changes! Installation Tip It is a good idea to first check out the Support page to see if your system is officially supported! Tip If you're facing some issues during/after installation, check out the Troubleshooting page for some common problems and solutions. To install bottom, refer to the installation section of the README.md , which contains a list of all the installation methods. Contribution New contributors are always welcome! See the contribution section for how to contribute to bottom, whether it be filing issues, writing documentation, creating pull requests, etc.","title":"Home"},{"location":"#bottom","text":"This site serves as extended documentation for bottom alongside the README.md . Warning Some areas of this site are still in progress and may be missing details. Feel free to suggest/contribute changes!","title":"bottom"},{"location":"#installation","text":"Tip It is a good idea to first check out the Support page to see if your system is officially supported! Tip If you're facing some issues during/after installation, check out the Troubleshooting page for some common problems and solutions. To install bottom, refer to the installation section of the README.md , which contains a list of all the installation methods.","title":"Installation"},{"location":"#contribution","text":"New contributors are always welcome! See the contribution section for how to contribute to bottom, whether it be filing issues, writing documentation, creating pull requests, etc.","title":"Contribution"},{"location":"troubleshooting/","text":"Troubleshooting The graph points look broken/strange It's possible that your graphs won't look great out of the box due to the reliance on braille fonts to draw them. One example of this is seeing a bunch of missing font characters, caused when the terminal isn't configured properly to render braille fonts. Powershell shown missing braille fonts One alternative is to use the --dot_marker option to render graph charts using dots instead of the braille characters, which generally seems better supported out of the box, at the expense of looking less intricate: Example using btm --dot_marker Another (better) alternative is to install a font that supports braille fonts, and configure your terminal to use it. For example, installing something like UBraille or Iosevka and ensuring your terminal uses it should work. Installing fonts for Windows Command Prompt/PowerShell Note: I would advise backing up your registry beforehand if you aren't sure what you are doing! Let's say you're installing Iosevka . The steps you can take are: Install the font itself. Open the registry editor, which you can do either by Win+R and opening regedit , or just opening it from the Start Menu. In the registry editor, go to HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Console\\TrueTypeFont Here, add a new String value , and set the Name to a bunch of 0's (e.g. 000 - make sure the name isn't already used), then set the Data to the font name (e.g. Iosevka ). The last entry is the new entry for Iosevka Then, open the Command Prompt/PowerShell, and right click on the top bar, and open Properties : From here, go to Font , and set the font to your new font (e.g. Iosevka ): Why can't I see all my temperature sensors on Windows? This is a known limitation , some sensors may require admin privileges to get sensor data. Why don't I see dual batteries on Windows reported separately? (e.g. Thinkpads) This is a known limitation which seems to be with how batteries are being detected on Windows. Why can't I see all my temperature sensors on WSL? This is a known limitation with WSL. Due to how it works, hosts may not expose their temperature sensors and therefore, temperature sensors might be missing. Why does WSL2 not match Task Manager? This is a known limitation with WSL2. Due to how WSL2 works, the two might not match up in terms of reported data. Why can't I see all my processes/process data on macOS? This is a known limitation , and you may have to run the program with elevated privileges to work around it - for example: sudo btm Please note that you should be certain that you trust any software you grant root privileges. There are measures taken to try to maximize the amount of information obtained without elevated privileges. For example, one can modify the instructions found on the htop wiki on how to run htop without sudo for bottom. However please understand the potential security risks before doing so! My configuration file isn't working If your configuration files aren't working, here are a few things to try: Check the formatting It may be handy toLine truncated
+23 -23
View File
@@ -2,117 +2,117 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://clementtsang.github.io/bottom/nightly/</loc>
<lastmod>2022-05-07</lastmod>
<lastmod>2022-05-08</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/troubleshooting/</loc>
<lastmod>2022-05-07</lastmod>
<lastmod>2022-05-08</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/configuration/command-line-flags/</loc>
<lastmod>2022-05-07</lastmod>
<lastmod>2022-05-08</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/configuration/config-file/data-filtering/</loc>
<lastmod>2022-05-07</lastmod>
<lastmod>2022-05-08</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/configuration/config-file/default-config/</loc>
<lastmod>2022-05-07</lastmod>
<lastmod>2022-05-08</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/configuration/config-file/flags/</loc>
<lastmod>2022-05-07</lastmod>
<lastmod>2022-05-08</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/configuration/config-file/layout/</loc>
<lastmod>2022-05-07</lastmod>
<lastmod>2022-05-08</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/configuration/config-file/theming/</loc>
<lastmod>2022-05-07</lastmod>
<lastmod>2022-05-08</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/contribution/development/</loc>
<lastmod>2022-05-07</lastmod>
<lastmod>2022-05-08</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/contribution/documentation/</loc>
<lastmod>2022-05-07</lastmod>
<lastmod>2022-05-08</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/contribution/issues-and-pull-requests/</loc>
<lastmod>2022-05-07</lastmod>
<lastmod>2022-05-08</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/contribution/packaging-and-distribution/</loc>
<lastmod>2022-05-07</lastmod>
<lastmod>2022-05-08</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/support/official/</loc>
<lastmod>2022-05-07</lastmod>
<lastmod>2022-05-08</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/support/unofficial/</loc>
<lastmod>2022-05-07</lastmod>
<lastmod>2022-05-08</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/usage/basic-mode/</loc>
<lastmod>2022-05-07</lastmod>
<lastmod>2022-05-08</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/usage/general-usage/</loc>
<lastmod>2022-05-07</lastmod>
<lastmod>2022-05-08</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/usage/widgets/battery/</loc>
<lastmod>2022-05-07</lastmod>
<lastmod>2022-05-08</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/usage/widgets/cpu/</loc>
<lastmod>2022-05-07</lastmod>
<lastmod>2022-05-08</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/usage/widgets/disk/</loc>
<lastmod>2022-05-07</lastmod>
<lastmod>2022-05-08</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/usage/widgets/memory/</loc>
<lastmod>2022-05-07</lastmod>
<lastmod>2022-05-08</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/usage/widgets/network/</loc>
<lastmod>2022-05-07</lastmod>
<lastmod>2022-05-08</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/usage/widgets/process/</loc>
<lastmod>2022-05-07</lastmod>
<lastmod>2022-05-08</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/nightly/usage/widgets/temperature/</loc>
<lastmod>2022-05-07</lastmod>
<lastmod>2022-05-08</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>
Binary file not shown.
+5 -10
View File
@@ -1015,21 +1015,16 @@
<h1 id="troubleshooting"><a class="toclink" href="#troubleshooting">Troubleshooting</a></h1>
<h2 id="the-graph-points-look-brokenstrange"><a class="toclink" href="#the-graph-points-look-brokenstrange">The graph points look broken/strange</a></h2>
<p>It's possible that your graphs won't look great out of the box due to the reliance on braille fonts.</p>
<p>One example of this is seeing a bunch of missing font characters, caused when the terminal isn't configured properly to render braille fonts.</p>
<p>It's possible that your graphs won't look great out of the box due to the reliance on braille fonts to draw them. One
example of this is seeing a bunch of missing font characters, caused when the terminal isn't configured properly to
render braille fonts.</p>
<figure>
<img src="../assets/screenshots/troubleshooting/no_braille.webp" alt="Example of a terminal with no braille font."/>
<figcaption>Powershell shown missing braille fonts</figcaption>
</figure>
<p>Another example is when braille is rendered as a block of dots, with the non-coloured dots also appearing. This may look strange for some users, and it is also caused by misconfiguration or missing fonts.</p>
<figure>
<img src="../assets/screenshots/troubleshooting/weird_braille.webp" alt="Example of a terminal with the wrong braille font."/>
<figcaption>Braille fonts rendering as a block of dots</figcaption>
</figure>
<p>One alternative is to use the <code>--dot_marker</code> option to render graph charts using dots instead of the braille characters, which generally seems better supported out of the box,
at the expense of looking less intricate:</p>
<p>One alternative is to use the <code>--dot_marker</code> option to render graph charts using dots instead of the braille characters,
which generally seems better supported out of the box, at the expense of looking less intricate:</p>
<figure>
<img src="../assets/screenshots/troubleshooting/dots.webp" alt="Example of running bottom with the dot marker flag"/>
<figcaption>Example using <code>btm --dot_marker</code></figcaption>