Deployed a90490fe to nightly with MkDocs 1.6.1 and mike 2.1.3

This commit is contained in:
github-actions[bot] committed 2025-03-21 09:21:29 +00:00
1 parent b53386a2a9
commit fea1220471
34 files changed
+2363 -9

No files matched your search

+24
View File
@@ -518,6 +518,8 @@
@@ -819,6 +821,28 @@
<li class="md-nav__item">
<a href="/bottom/stable/usage/autocomplete/" class="md-nav__link">
<span class="md-ellipsis">
Auto-Complete
</span>
</a>
</li>
</ul>
</nav>
@@ -15,7 +15,7 @@
<link rel="canonical" href="https://clementtsang.github.io/bottom/stable/configuration/command-line-options/">
<link rel="prev" href="../../usage/widgets/battery/">
<link rel="prev" href="../../usage/autocomplete/">
<link rel="next" href="../config-file/">
@@ -531,6 +531,8 @@
@@ -832,6 +834,28 @@
<li class="md-nav__item">
<a href="../../usage/autocomplete/" class="md-nav__link">
<span class="md-ellipsis">
Auto-Complete
</span>
</a>
</li>
</ul>
</nav>
@@ -1926,7 +1950,7 @@ see information on these options by running <code>btm -h</code>, or run <code>bt
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../../usage/widgets/battery/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Battery Widget">
<a href="../../usage/autocomplete/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Auto-Complete">
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
@@ -1936,7 +1960,7 @@ see information on these options by running <code>btm -h</code>, or run <code>bt
Previous
</span>
<div class="md-ellipsis">
Battery Widget
Auto-Complete
</div>
</div>
</a>
@@ -525,6 +525,8 @@
@@ -826,6 +828,28 @@
<li class="md-nav__item">
<a href="../../../usage/autocomplete/" class="md-nav__link">
<span class="md-ellipsis">
Auto-Complete
</span>
</a>
</li>
</ul>
</nav>
@@ -531,6 +531,8 @@
@@ -832,6 +834,28 @@
<li class="md-nav__item">
<a href="../../../usage/autocomplete/" class="md-nav__link">
<span class="md-ellipsis">
Auto-Complete
</span>
</a>
</li>
</ul>
</nav>
@@ -531,6 +531,8 @@
@@ -832,6 +834,28 @@
<li class="md-nav__item">
<a href="../../../usage/autocomplete/" class="md-nav__link">
<span class="md-ellipsis">
Auto-Complete
</span>
</a>
</li>
</ul>
</nav>
@@ -531,6 +531,8 @@
@@ -832,6 +834,28 @@
<li class="md-nav__item">
<a href="../../usage/autocomplete/" class="md-nav__link">
<span class="md-ellipsis">
Auto-Complete
</span>
</a>
</li>
</ul>
</nav>
@@ -531,6 +531,8 @@
@@ -832,6 +834,28 @@
<li class="md-nav__item">
<a href="../../../usage/autocomplete/" class="md-nav__link">
<span class="md-ellipsis">
Auto-Complete
</span>
</a>
</li>
</ul>
</nav>
@@ -531,6 +531,8 @@
@@ -832,6 +834,28 @@
<li class="md-nav__item">
<a href="../../../usage/autocomplete/" class="md-nav__link">
<span class="md-ellipsis">
Auto-Complete
</span>
</a>
</li>
</ul>
</nav>
@@ -531,6 +531,8 @@
@@ -832,6 +834,28 @@
<li class="md-nav__item">
<a href="../../../usage/autocomplete/" class="md-nav__link">
<span class="md-ellipsis">
Auto-Complete
</span>
</a>
</li>
</ul>
</nav>
@@ -531,6 +531,8 @@
@@ -832,6 +834,28 @@
<li class="md-nav__item">
<a href="../../../usage/autocomplete/" class="md-nav__link">
<span class="md-ellipsis">
Auto-Complete
</span>
</a>
</li>
</ul>
</nav>
@@ -531,6 +531,8 @@
@@ -832,6 +834,28 @@
<li class="md-nav__item">
<a href="../../../usage/autocomplete/" class="md-nav__link">
<span class="md-ellipsis">
Auto-Complete
</span>
</a>
</li>
</ul>
</nav>
@@ -531,6 +531,8 @@
@@ -832,6 +834,28 @@
<li class="md-nav__item">
<a href="../../../usage/autocomplete/" class="md-nav__link">
<span class="md-ellipsis">
Auto-Complete
</span>
</a>
</li>
</ul>
</nav>
@@ -531,6 +531,8 @@
@@ -832,6 +834,28 @@
<li class="md-nav__item">
<a href="../../../usage/autocomplete/" class="md-nav__link">
<span class="md-ellipsis">
Auto-Complete
</span>
</a>
</li>
</ul>
</nav>
@@ -531,6 +531,8 @@
@@ -832,6 +834,28 @@
<li class="md-nav__item">
<a href="../../../usage/autocomplete/" class="md-nav__link">
<span class="md-ellipsis">
Auto-Complete
</span>
</a>
</li>
</ul>
</nav>
@@ -531,6 +531,8 @@
@@ -832,6 +834,28 @@
<li class="md-nav__item">
<a href="../../usage/autocomplete/" class="md-nav__link">
<span class="md-ellipsis">
Auto-Complete
</span>
</a>
</li>
</ul>
</nav>
@@ -531,6 +531,8 @@
@@ -832,6 +834,28 @@
<li class="md-nav__item">
<a href="../../usage/autocomplete/" class="md-nav__link">
<span class="md-ellipsis">
Auto-Complete
</span>
</a>
</li>
</ul>
</nav>
@@ -531,6 +531,8 @@
@@ -832,6 +834,28 @@
<li class="md-nav__item">
<a href="../../usage/autocomplete/" class="md-nav__link">
<span class="md-ellipsis">
Auto-Complete
</span>
</a>
</li>
</ul>
</nav>
+26 -2
View File
@@ -597,6 +597,8 @@
@@ -898,6 +900,28 @@
<li class="md-nav__item">
<a href="usage/autocomplete/" class="md-nav__link">
<span class="md-ellipsis">
Auto-Complete
</span>
</a>
</li>
</ul>
</nav>
@@ -1536,7 +1560,7 @@ which contains a list of all the installation methods.</p>
<h2 id="usage-and-configuration"><a class="toclink" href="#usage-and-configuration">Usage and configuration</a></h2>
<p>The command to run bottom is <code>btm</code>.</p>
<p>You can refer to the <a href="usage/general-usage/">usage</a> pages for more details on using bottom (e.g. keybinds, some features, a general overview of what each widget does).</p>
<p>To configure bottom (e.g. how it behaves, how it looks, etc.) refer to the <a href="configuration/command-line-options/">command-line options page</a> for temporary settings, or <a href="configuration/config-file">the config file page</a> for more permanent settings.</p>
<p>To configure bottom (e.g. how it behaves, how it looks, etc.) refer to the <a href="configuration/command-line-options/">command-line options page</a> for temporary settings, or <a href="configuration/config-file/">the config file page</a> for more permanent settings.</p>
<h2 id="contribution"><a class="toclink" href="#contribution">Contribution</a></h2>
<p>New contributors are always welcome! See the <a href="contribution/issues-and-pull-requests/">contribution</a> section for how to contribute to
bottom, whether it be filing issues, writing documentation, creating pull requests, etc.</p>
@@ -1560,7 +1584,7 @@ bottom, whether it be filing issues, writing documentation, creating pull reques
<span class="md-icon" title="Last update">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">February 20, 2024</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">March 21, 2025</span>
</span>
+1 -1
View File
@@ -1 +1 @@
{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"<code>bottom</code>","text":"<p>A customizable cross-platform graphical process/system monitor for the terminal, supporting Linux, macOS, and Windows. Inspired by other tools like gtop, gotop, and htop.</p> <p>This site serves as extended documentation for bottom alongside the <code>README.md</code>.</p> <p>Warning</p> <p>Some areas of this site are still in progress and may be missing details. Feel free to suggest/contribute changes!</p>"},{"location":"#installation","title":"Installation","text":"<p>Tip</p> <p>It's as good idea to first check out the Support page to see if your system is officially supported!</p> <p>Tip</p> <p>If you're facing some issues during/after installation, check out the Troubleshooting page for some common problems and solutions.</p> <p>To install bottom, refer to the installation section of the <code>README.md</code>, which contains a list of all the installation methods.</p>"},{"location":"#usage-and-configuration","title":"Usage and configuration","text":"<p>The command to run bottom is <code>btm</code>.</p> <p>You can refer to the usage pages for more details on using bottom (e.g. keybinds, some features, a general overview of what each widget does).</p> <p>To configure bottom (e.g. how it behaves, how it looks, etc.) refer to the command-line options page for temporary settings, or the config file page for more permanent settings.</p>"},{"location":"#contribution","title":"Contribution","text":"<p>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.</p>"},{"location":"troubleshooting/","title":"Troubleshooting","text":""},{"location":"troubleshooting/#the-graph-points-look-brokenstrange","title":"The graph points look broken/strange","text":"<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> <sub>An example of missing braille fonts in Powershell</sub> <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> <sub>Example using <code>btm --dot_marker</code></sub> <p>Another (better) alternative is to install a font that supports braille fonts, and configure your terminal emulator to use it. For example, installing something like UBraille or Iosevka and ensuring your terminal uses it should work.</p>"},{"location":"troubleshooting/#linuxmacosunix","title":"Linux/macOS/Unix","text":"<p>If you're on a Unix-like system, generally, the problem comes down to you either not having a font that supports the braille markers, or your terminal emulator is not using the correct font for the braille markers.</p> <p>Some possible solutions include:</p> <ul> <li>Uninstalling <code>gnu-free-fonts</code> if installed, as that is known to cause problems with braille markers</li> <li>Installing a font like <code>ttf-symbola</code> or <code>ttf-ubraille</code> for your terminal emulator to try and automatically fall back to</li> <li>Configuring your terminal emulator to use specific fonts for the <code>U+2800</code> to <code>U+28FF</code> range.<ul> <li>For example for kitty, do <code>symbol_map U+2800-U+28FF Symbola</code>.</li> </ul> </li> </ul> <p>See this issue for more possible fixes.</p> <p>If you're still having issues, feel free to open a discussion question about it.</p>"},{"location":"troubleshooting/#windowspowershell","title":"Windows/Powershell","text":"<p>Note: I would advise backing up your registry beforehand if you aren't sure what you are doing!</p> <p>Let's say you're installing Iosevka. The steps you can take are:</p> <ol> <li>Install the font itself.</li> <li>Open the registry editor, which you can do either by <code>Win+R</code> and opening <code>regedit</code>, or just opening it from the Start Menu.</li> <li> <p>In the registry editor, go to</p> <pre><code>HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Console\\TrueTypeFont\n</code></pre> </li> <li> <p>Here, add a new <code>String value</code>, and set the <code>Name</code> to a bunch of 0's (e.g. <code>000</code> - make sure the name isn't already used), then set the <code>Data</code> to the font name (e.g. <code>Iosevka</code>).</p> </li> </ol> <sub>The last entry is the new entry for Iosevka</sub> <ol> <li>Then, open the Command Prompt/PowerShell, and right-click on the top bar, and open \"Properties\":</li> </ol> <ol> <li>From here, go to \"Font\", and set the font to your new font (so in this example, Iosevka):</li> </ol>"},{"location":"troubleshooting/#why-cant-i-see-all-my-teLine truncated
{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"<code>bottom</code>","text":"<p>A customizable cross-platform graphical process/system monitor for the terminal, supporting Linux, macOS, and Windows. Inspired by other tools like gtop, gotop, and htop.</p> <p>This site serves as extended documentation for bottom alongside the <code>README.md</code>.</p> <p>Warning</p> <p>Some areas of this site are still in progress and may be missing details. Feel free to suggest/contribute changes!</p>"},{"location":"#installation","title":"Installation","text":"<p>Tip</p> <p>It's as good idea to first check out the Support page to see if your system is officially supported!</p> <p>Tip</p> <p>If you're facing some issues during/after installation, check out the Troubleshooting page for some common problems and solutions.</p> <p>To install bottom, refer to the installation section of the <code>README.md</code>, which contains a list of all the installation methods.</p>"},{"location":"#usage-and-configuration","title":"Usage and configuration","text":"<p>The command to run bottom is <code>btm</code>.</p> <p>You can refer to the usage pages for more details on using bottom (e.g. keybinds, some features, a general overview of what each widget does).</p> <p>To configure bottom (e.g. how it behaves, how it looks, etc.) refer to the command-line options page for temporary settings, or the config file page for more permanent settings.</p>"},{"location":"#contribution","title":"Contribution","text":"<p>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.</p>"},{"location":"troubleshooting/","title":"Troubleshooting","text":""},{"location":"troubleshooting/#the-graph-points-look-brokenstrange","title":"The graph points look broken/strange","text":"<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> <sub>An example of missing braille fonts in Powershell</sub> <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> <sub>Example using <code>btm --dot_marker</code></sub> <p>Another (better) alternative is to install a font that supports braille fonts, and configure your terminal emulator to use it. For example, installing something like UBraille or Iosevka and ensuring your terminal uses it should work.</p>"},{"location":"troubleshooting/#linuxmacosunix","title":"Linux/macOS/Unix","text":"<p>If you're on a Unix-like system, generally, the problem comes down to you either not having a font that supports the braille markers, or your terminal emulator is not using the correct font for the braille markers.</p> <p>Some possible solutions include:</p> <ul> <li>Uninstalling <code>gnu-free-fonts</code> if installed, as that is known to cause problems with braille markers</li> <li>Installing a font like <code>ttf-symbola</code> or <code>ttf-ubraille</code> for your terminal emulator to try and automatically fall back to</li> <li>Configuring your terminal emulator to use specific fonts for the <code>U+2800</code> to <code>U+28FF</code> range.<ul> <li>For example for kitty, do <code>symbol_map U+2800-U+28FF Symbola</code>.</li> </ul> </li> </ul> <p>See this issue for more possible fixes.</p> <p>If you're still having issues, feel free to open a discussion question about it.</p>"},{"location":"troubleshooting/#windowspowershell","title":"Windows/Powershell","text":"<p>Note: I would advise backing up your registry beforehand if you aren't sure what you are doing!</p> <p>Let's say you're installing Iosevka. The steps you can take are:</p> <ol> <li>Install the font itself.</li> <li>Open the registry editor, which you can do either by <code>Win+R</code> and opening <code>regedit</code>, or just opening it from the Start Menu.</li> <li> <p>In the registry editor, go to</p> <pre><code>HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Console\\TrueTypeFont\n</code></pre> </li> <li> <p>Here, add a new <code>String value</code>, and set the <code>Name</code> to a bunch of 0's (e.g. <code>000</code> - make sure the name isn't already used), then set the <code>Data</code> to the font name (e.g. <code>Iosevka</code>).</p> </li> </ol> <sub>The last entry is the new entry for Iosevka</sub> <ol> <li>Then, open the Command Prompt/PowerShell, and right-click on the top bar, and open \"Properties\":</li> </ol> <ol> <li>From here, go to \"Font\", and set the font to your new font (so in this example, Iosevka):</li> </ol>"},{"location":"troubleshooting/#why-cant-i-see-all-my-teLine truncated
+4
View File
@@ -80,6 +80,10 @@
<loc>https://clementtsang.github.io/bottom/stable/support/unofficial/</loc>
<lastmod>2025-03-21</lastmod>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/stable/usage/autocomplete/</loc>
<lastmod>2025-03-21</lastmod>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/stable/usage/basic-mode/</loc>
<lastmod>2025-03-21</lastmod>
Binary file not shown.
+24
View File
@@ -617,6 +617,8 @@
@@ -918,6 +920,28 @@
<li class="md-nav__item">
<a href="../../usage/autocomplete/" class="md-nav__link">
<span class="md-ellipsis">
Auto-Complete
</span>
</a>
</li>
</ul>
</nav>
+24
View File
@@ -584,6 +584,8 @@
@@ -885,6 +887,28 @@
<li class="md-nav__item">
<a href="../../usage/autocomplete/" class="md-nav__link">
<span class="md-ellipsis">
Auto-Complete
</span>
</a>
</li>
</ul>
</nav>
+24
View File
@@ -529,6 +529,8 @@
@@ -830,6 +832,28 @@
<li class="md-nav__item">
<a href="../usage/autocomplete/" class="md-nav__link">
<span class="md-ellipsis">
Auto-Complete
</span>
</a>
</li>
</ul>
</nav>
File diff suppressed because it is too large. Load diff
+24
View File
@@ -531,6 +531,8 @@
@@ -897,6 +899,28 @@
<li class="md-nav__item">
<a href="../autocomplete/" class="md-nav__link">
<span class="md-ellipsis">
Auto-Complete
</span>
</a>
</li>
</ul>
</nav>
+24
View File
@@ -531,6 +531,8 @@
@@ -930,6 +932,28 @@
<li class="md-nav__item">
<a href="../autocomplete/" class="md-nav__link">
<span class="md-ellipsis">
Auto-Complete
</span>
</a>
</li>
</ul>
</nav>
+27 -3
View File
@@ -18,7 +18,7 @@
<link rel="prev" href="../temperature/">
<link rel="next" href="../../../configuration/command-line-options/">
<link rel="next" href="../../autocomplete/">
<link rel="icon" href="../../../assets/images/favicon.png">
@@ -531,6 +531,8 @@
@@ -906,6 +908,28 @@
<li class="md-nav__item">
<a href="../../autocomplete/" class="md-nav__link">
<span class="md-ellipsis">
Auto-Complete
</span>
</a>
</li>
</ul>
</nav>
@@ -1651,13 +1675,13 @@
<a href="../../../configuration/command-line-options/" class="md-footer__link md-footer__link--next" aria-label="Next: Command-line Options">
<a href="../../autocomplete/" class="md-footer__link md-footer__link--next" aria-label="Next: Auto-Complete">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
</span>
<div class="md-ellipsis">
Command-line Options
Auto-Complete
</div>
</div>
<div class="md-footer__button md-icon">
+24
View File
@@ -531,6 +531,8 @@
@@ -954,6 +956,28 @@
<li class="md-nav__item">
<a href="../../autocomplete/" class="md-nav__link">
<span class="md-ellipsis">
Auto-Complete
</span>
</a>
</li>
</ul>
</nav>
+24
View File
@@ -531,6 +531,8 @@
@@ -906,6 +908,28 @@
<li class="md-nav__item">
<a href="../../autocomplete/" class="md-nav__link">
<span class="md-ellipsis">
Auto-Complete
</span>
</a>
</li>
</ul>
</nav>
+24
View File
@@ -531,6 +531,8 @@
@@ -915,6 +917,28 @@
<li class="md-nav__item">
<a href="../../autocomplete/" class="md-nav__link">
<span class="md-ellipsis">
Auto-Complete
</span>
</a>
</li>
</ul>
</nav>
+24
View File
@@ -531,6 +531,8 @@
@@ -906,6 +908,28 @@
<li class="md-nav__item">
<a href="../../autocomplete/" class="md-nav__link">
<span class="md-ellipsis">
Auto-Complete
</span>
</a>
</li>
</ul>
</nav>
+24
View File
@@ -531,6 +531,8 @@
@@ -1065,6 +1067,28 @@
<li class="md-nav__item">
<a href="../../autocomplete/" class="md-nav__link">
<span class="md-ellipsis">
Auto-Complete
</span>
</a>
</li>
</ul>
</nav>
@@ -531,6 +531,8 @@
@@ -906,6 +908,28 @@
<li class="md-nav__item">
<a href="../../autocomplete/" class="md-nav__link">
<span class="md-ellipsis">
Auto-Complete
</span>
</a>
</li>
</ul>
</nav>