tyler.durden/bottom
1
0
Fork 0
mirror of https://github.com/ClementTsang/bottom.git synced 2025-04-08 17:05:59 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: use bottom.pages.dev

Browse Source 
This _might_ stick, this might not. I may only do this after releasing
one more stable version. We'll see.
This commit is contained in:
ClementTsang 2025-03-28 00:15:24 -04:00
parent f8b8a21748
commit 13ad660ce9
No known key found for this signature in database
GPG Key ID: DC3B7867D8D97095
12 changed files with 86 additions and 235 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.github/ISSUE_TEMPLATE/bug_report.yml vendored
View File

@ -8,8 +8,8 @@ body:
label: Checklist
options:
- label: >
I've looked through the [troubleshooting docs](https://clementtsang.github.io/bottom/nightly/troubleshooting),
[the known problems list](https://clementtsang.github.io/bottom/nightly/support/official/#known-problems), and
I've looked through the [troubleshooting docs](https://bottom.pages.dev/nightly/troubleshooting),
[the known problems list](https://bottom.pages.dev/nightly/support/official/#known-problems), and
[existing open issues](https://github.com/ClementTsang/bottom/issues?q=is%3Aopen+is%3Aissue) for similar
issues.
required: true

2
.github/ISSUE_TEMPLATE/feature_request.yml vendored
View File

@ -8,7 +8,7 @@ body:
label: Checklist
options:
- label: >
I've looked through [the documentation](https://clementtsang.github.io/bottom/nightly/) and
I've looked through [the documentation](https://bottom.pages.dev/nightly/) and
[existing open issues](https://github.com/ClementTsang/bottom/issues?q=is%3Aopen+is%3Aissue+label%3Afeature)
for similar feature requests.
required: true

2
.github/ISSUE_TEMPLATE/packaging.yml vendored
View File

@ -7,7 +7,7 @@ body:
value: >
If this is an issue about supporting a new package/installation method for a platform you use, please
consider maintaining it yourself/with others and submitting a PR or issue with a link to it - they'll be
very much appreciated and likely added to the README quickly. [The documentation on packaging/distribution](https://clementtsang.github.io/bottom/nightly/contribution/packaging-and-distribution/)
very much appreciated and likely added to the README quickly. [The documentation on packaging/distribution](https://bottom.pages.dev/nightly/contribution/packaging-and-distribution/)
may be helpful in setting things up. If there are some issues with bottom itself causing problems with
packaging, feel free to open an appropriate issue.

8
CONTRIBUTING.md
View File

@ -19,7 +19,7 @@ If you want to directly contribute documentation changes or code, follow this! T
1. Fork the project.
2. Make your changes.
3. Make any documentation changes if necessary - if you add a new feature, it'll probably need documentation changes. See [here](https://clementtsang.github.io/bottom/nightly/contribution/documentation/) for tips on documentation.
3. Make any documentation changes if necessary - if you add a new feature, it'll probably need documentation changes. See [here](https://bottom.pages.dev/nightly/contribution/documentation/) for tips on documentation.
4. Commit and create a pull request to merge into the `main` branch. **Please fill out the pull request template**.
5. Ask a maintainer to review your pull request.
- Check if the CI workflow passes. These consist of clippy lints, rustfmt checks, and basic tests. If you are a
@ -28,13 +28,13 @@ If you want to directly contribute documentation changes or code, follow this! T
6. Once it looks good, it'll be merged! Note that _generally_, PRs are squashed to maintain repo cleanliness, though
feel free to ask otherwise if that isn't preferable.
For more details, see [here](https://clementtsang.github.io/bottom/nightly/contribution/issues-and-pull-requests/).
For more details, see [here](https://bottom.pages.dev/nightly/contribution/issues-and-pull-requests/).
### Documentation
For contributing to documentation, see [here](https://clementtsang.github.io/bottom/nightly/contribution/documentation/).
For contributing to documentation, see [here](https://bottom.pages.dev/nightly/contribution/documentation/).
### Packaging
If you want to become a package maintainer, see [here](https://clementtsang.github.io/bottom/nightly/contribution/packaging-and-distribution/)
If you want to become a package maintainer, see [here](https://bottom.pages.dev/nightly/contribution/packaging-and-distribution/)
for details on how to build bottom, how to generate/obtain completion files and manpages, and how to add installation instructions for the package to the README.

2
Cargo.toml
View File

@ -4,7 +4,7 @@ version = "0.11.0"
repository = "https://github.com/ClementTsang/bottom"
license = "MIT"
description = "A customizable cross-platform graphical process/system monitor for the terminal. Supports Linux, macOS, and Windows."
documentation = "https://clementtsang.github.io/bottom/stable"
documentation = "https://bottom.pages.dev/stable"
readme = "README.md"
default-run = "btm"
build = "build.rs"

42
README.md
View File

@ -7,8 +7,8 @@
[<img src="https://img.shields.io/github/actions/workflow/status/ClementTsang/bottom/ci.yml?branch=main&style=flat-square&logo=github" alt="CI status">](https://github.com/ClementTsang/bottom/actions?query=branch%main)
[<img src="https://img.shields.io/crates/v/bottom.svg?style=flat-square" alt="crates.io link">](https://crates.io/crates/bottom)
[<img src="https://img.shields.io/badge/docs-stable-66c2a5?style=flat-square&labelColor=555555&logoColor=white" alt="Stable documentation">](https://clementtsang.github.io/bottom/stable)
[<img src="https://img.shields.io/badge/docs-nightly-88c0d0?style=flat-square&labelColor=555555&logoColor=white" alt="Nightly documentation">](https://clementtsang.github.io/bottom/nightly)
[<img src="https://img.shields.io/badge/docs-stable-66c2a5?style=flat-square&labelColor=555555&logoColor=white" alt="Stable documentation">](https://bottom.pages.dev/stable)
[<img src="https://img.shields.io/badge/docs-nightly-88c0d0?style=flat-square&labelColor=555555&logoColor=white" alt="Nightly documentation">](https://bottom.pages.dev/nightly)
</div>
@ -62,26 +62,26 @@ As (yet another) process/system visualization and management application, bottom
- Graphical visualization widgets for:
- [CPU usage](https://clementtsang.github.io/bottom/nightly/usage/widgets/cpu/) over time, at an average and per-core level
- [RAM and swap usage](https://clementtsang.github.io/bottom/nightly/usage/widgets/memory/) over time
- [Network I/O usage](https://clementtsang.github.io/bottom/nightly/usage/widgets/network/) over time
- [CPU usage](https://bottom.pages.dev/nightly/usage/widgets/cpu/) over time, at an average and per-core level
- [RAM and swap usage](https://bottom.pages.dev/nightly/usage/widgets/memory/) over time
- [Network I/O usage](https://bottom.pages.dev/nightly/usage/widgets/network/) over time
with support for zooming in/out the current time interval displayed.
- Widgets for displaying info about:
- [Disk capacity/usage](https://clementtsang.github.io/bottom/nightly/usage/widgets/disk/)
- [Temperature sensors](https://clementtsang.github.io/bottom/nightly/usage/widgets/temperature/)
- [Battery usage](https://clementtsang.github.io/bottom/nightly/usage/widgets/battery/)
- [Disk capacity/usage](https://bottom.pages.dev/nightly/usage/widgets/disk/)
- [Temperature sensors](https://bottom.pages.dev/nightly/usage/widgets/temperature/)
- [Battery usage](https://bottom.pages.dev/nightly/usage/widgets/battery/)
- [A process widget](https://clementtsang.github.io/bottom/nightly/usage/widgets/process/) for displaying, sorting, and searching info about processes, as well as support for:
- [A process widget](https://bottom.pages.dev/nightly/usage/widgets/process/) for displaying, sorting, and searching info about processes, as well as support for:
- [Kill signals](https://clementtsang.github.io/bottom/nightly/usage/widgets/process/#process-termination)
- [Tree mode](https://clementtsang.github.io/bottom/nightly/usage/widgets/process/#tree-mode)
- [Kill signals](https://bottom.pages.dev/nightly/usage/widgets/process/#process-termination)
- [Tree mode](https://bottom.pages.dev/nightly/usage/widgets/process/#tree-mode)
- [Cross-platform support](https://github.com/ClementTsang/bottom#support) for Linux, macOS, and Windows, with more planned in the future.
- [Customizable behaviour](https://clementtsang.github.io/bottom/nightly/configuration/command-line-options/) that can be controlled with command-line options or a config file, such as:
- [Customizable behaviour](https://bottom.pages.dev/nightly/configuration/command-line-options/) that can be controlled with command-line options or a config file, such as:
- Custom and built-in colour themes
- Customizing widget behaviour
@ -90,12 +90,12 @@ As (yet another) process/system visualization and management application, bottom
- And more:
- [An htop-inspired basic mode](https://clementtsang.github.io/bottom/nightly/usage/basic-mode/)
- [Expansion, which focuses on just one widget](https://clementtsang.github.io/bottom/nightly/usage/general-usage/#expansion)
- [An htop-inspired basic mode](https://bottom.pages.dev/nightly/usage/basic-mode/)
- [Expansion, which focuses on just one widget](https://bottom.pages.dev/nightly/usage/general-usage/#expansion)
- And more!
You can find more details in [the documentation](https://clementtsang.github.io/bottom/nightly/usage/general-usage/).
You can find more details in [the documentation](https://bottom.pages.dev/nightly/usage/general-usage/).
## Support
@ -110,7 +110,7 @@ bottom _officially_ supports the following operating systems and corresponding a
These platforms are tested to work for the most part and issues on these platforms will be fixed if possible.
Furthermore, binaries are built and tested using the most recent version of stable Rust at the time.
For more details on supported platforms and known problems, check out [the documentation](https://clementtsang.github.io/bottom/nightly/support/official/).
For more details on supported platforms and known problems, check out [the documentation](https://bottom.pages.dev/nightly/support/official/).
### Unofficial
@ -128,7 +128,7 @@ A non-comprehensive list of some currently unofficially-supported platforms that
- Linux (`armv6`, `armv7`, `powerpc64le`, `riscv64gc`)
- Android (`arm64`)
For more details on unsupported platforms and known problems, check out [the documentation](https://clementtsang.github.io/bottom/nightly/support/unofficial/).
For more details on unsupported platforms and known problems, check out [the documentation](https://bottom.pages.dev/nightly/support/unofficial/).
## Installation
@ -425,20 +425,20 @@ The individual auto-completion files are also included in the stable/nightly rel
You can run bottom using `btm`.
- For help on flags, use `btm -h` for a quick overview or `btm --help` for more details.
- For info on key and mouse bindings, press `?` inside bottom or refer to the [documentation page](https://clementtsang.github.io/bottom/nightly/).
- For info on key and mouse bindings, press `?` inside bottom or refer to the [documentation page](https://bottom.pages.dev/nightly/).
You can find more information on usage in the [documentation](https://clementtsang.github.io/bottom/nightly/).
You can find more information on usage in the [documentation](https://bottom.pages.dev/nightly/).
## Configuration
bottom accepts a number of command-line arguments to change the behaviour of the application as desired.
Additionally, bottom will automatically generate a configuration file on the first launch, which can be changed.
More details on configuration can be found [in the documentation](https://clementtsang.github.io/bottom/nightly/configuration/config-file/).
More details on configuration can be found [in the documentation](https://bottom.pages.dev/nightly/configuration/config-file/).
## Troubleshooting
If some things aren't working, give the [troubleshooting page](https://clementtsang.github.io/bottom/nightly/troubleshooting)
If some things aren't working, give the [troubleshooting page](https://bottom.pages.dev/nightly/troubleshooting)
a look. If things still aren't working, then consider asking [a question](https://github.com/ClementTsang/bottom/discussions)
or filing a [bug report](https://github.com/ClementTsang/bottom/issues/new/choose) if you think it's a bug.

2
docs/mkdocs.yml
View File

@ -1,7 +1,7 @@
# Site information
site_name: bottom
site_author: Clement Tsang
site_url: https://clementtsang.github.io/bottom
site_url: https://bottom.pages.dev
site_description: >-
A customizable cross-platform graphical process/system monitor for the terminal. Supports Linux, macOS, and Windows.
docs_dir: "content/"

251
schema/nightly/bottom.json
View File

@ -2,7 +2,7 @@
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://github.com/ClementTsang/bottom/blob/main/schema/nightly/bottom.json",
"title": "Schema for bottom's config file (nightly)",
"description": "https://clementtsang.github.io/bottom/nightly/configuration/config-file",
"description": "https://bottom.pages.dev/nightly/configuration/config-file",
"type": "object",
"properties": {
"cpu": {
@ -56,10 +56,7 @@
]
},
"row": {
"type": [
"array",
"null"
],
"type": ["array", "null"],
"items": {
"$ref": "#/definitions/row"
}
@ -140,10 +137,7 @@
"CpuDefault": {
"description": "The default selection of the CPU widget. If the given selection is invalid, we will fall back to all.",
"type": "string",
"enum": [
"all",
"average"
]
"enum": ["all", "average"]
},
"CpuStyle": {
"description": "Styling specific to the CPU widget.",
@ -173,10 +167,7 @@
},
"cpu_core_colors": {
"description": "Colour of each CPU threads' label and graph line. Read in order.",
"type": [
"array",
"null"
],
"type": ["array", "null"],
"items": {
"$ref": "#/definitions/ColorStr"
}
@ -239,21 +230,13 @@
"FinalWidget": {
"description": "Represents a widget.",
"type": "object",
"required": [
"type"
],
"required": ["type"],
"properties": {
"default": {
"type": [
"boolean",
"null"
]
"type": ["boolean", "null"]
},
"ratio": {
"type": [
"integer",
"null"
],
"type": ["integer", "null"],
"format": "uint32",
"minimum": 0.0
},
@ -266,46 +249,25 @@
"type": "object",
"properties": {
"autohide_time": {
"type": [
"boolean",
"null"
]
"type": ["boolean", "null"]
},
"average_cpu_row": {
"type": [
"boolean",
"null"
]
"type": ["boolean", "null"]
},
"basic": {
"type": [
"boolean",
"null"
]
"type": ["boolean", "null"]
},
"battery": {
"type": [
"boolean",
"null"
]
"type": ["boolean", "null"]
},
"case_sensitive": {
"type": [
"boolean",
"null"
]
"type": ["boolean", "null"]
},
"cpu_left_legend": {
"type": [
"boolean",
"null"
]
"type": ["boolean", "null"]
},
"current_usage": {
"type": [
"boolean",
"null"
]
"type": ["boolean", "null"]
},
"default_time_value": {
"anyOf": [
@ -318,126 +280,66 @@
]
},
"default_widget_count": {
"type": [
"integer",
"null"
],
"type": ["integer", "null"],
"format": "uint64",
"minimum": 0.0
},
"default_widget_type": {
"type": [
"string",
"null"
]
"type": ["string", "null"]
},
"disable_advanced_kill": {
"type": [
"boolean",
"null"
]
"type": ["boolean", "null"]
},
"disable_click": {
"type": [
"boolean",
"null"
]
"type": ["boolean", "null"]
},
"disable_gpu": {
"type": [
"boolean",
"null"
]
"type": ["boolean", "null"]
},
"dot_marker": {
"type": [
"boolean",
"null"
]
"type": ["boolean", "null"]
},
"enable_cache_memory": {
"type": [
"boolean",
"null"
]
"type": ["boolean", "null"]
},
"expanded": {
"type": [
"boolean",
"null"
]
"type": ["boolean", "null"]
},
"group_processes": {
"type": [
"boolean",
"null"
]
"type": ["boolean", "null"]
},
"hide_avg_cpu": {
"type": [
"boolean",
"null"
]
"type": ["boolean", "null"]
},
"hide_table_gap": {
"type": [
"boolean",
"null"
]
"type": ["boolean", "null"]
},
"hide_time": {
"type": [
"boolean",
"null"
]
"type": ["boolean", "null"]
},
"memory_legend": {
"type": [
"string",
"null"
]
"type": ["string", "null"]
},
"network_legend": {
"type": [
"string",
"null"
]
"type": ["string", "null"]
},
"network_use_binary_prefix": {
"type": [
"boolean",
"null"
]
"type": ["boolean", "null"]
},
"network_use_bytes": {
"type": [
"boolean",
"null"
]
"type": ["boolean", "null"]
},
"network_use_log": {
"type": [
"boolean",
"null"
]
"type": ["boolean", "null"]
},
"no_write": {
"type": [
"boolean",
"null"
]
"type": ["boolean", "null"]
},
"process_command": {
"type": [
"boolean",
"null"
]
"type": ["boolean", "null"]
},
"process_memory_as_value": {
"type": [
"boolean",
"null"
]
"type": ["boolean", "null"]
},
"rate": {
"anyOf": [
@ -450,10 +352,7 @@
]
},
"regex": {
"type": [
"boolean",
"null"
]
"type": ["boolean", "null"]
},
"retention": {
"anyOf": [
@ -466,16 +365,10 @@
]
},
"show_table_scroll_position": {
"type": [
"boolean",
"null"
]
"type": ["boolean", "null"]
},
"temperature_type": {
"type": [
"string",
"null"
]
"type": ["string", "null"]
},
"time_delta": {
"anyOf": [
@ -488,28 +381,16 @@
]
},
"tree": {
"type": [
"boolean",
"null"
]
"type": ["boolean", "null"]
},
"unnormalized_cpu": {
"type": [
"boolean",
"null"
]
"type": ["boolean", "null"]
},
"use_old_network_legend": {
"type": [
"boolean",
"null"
]
"type": ["boolean", "null"]
},
"whole_word": {
"type": [
"boolean",
"null"
]
"type": ["boolean", "null"]
}
}
},
@ -543,9 +424,7 @@
},
"IgnoreList": {
"type": "object",
"required": [
"list"
],
"required": ["list"],
"properties": {
"case_sensitive": {
"default": false,
@ -599,10 +478,7 @@
},
"gpu_colors": {
"description": "Colour of each GPU's memory label and graph line. Read in order.",
"type": [
"array",
"null"
],
"type": ["array", "null"],
"items": {
"$ref": "#/definitions/ColorStr"
}
@ -748,9 +624,7 @@
},
{
"type": "object",
"required": [
"child"
],
"required": ["child"],
"properties": {
"child": {
"type": "array",
@ -759,10 +633,7 @@
}
},
"ratio": {
"type": [
"integer",
"null"
],
"type": ["integer", "null"],
"format": "uint32",
"minimum": 0.0
}
@ -854,10 +725,7 @@
},
"theme": {
"description": "A built-in theme.\n\nIf this is and a custom colour are both set, in the config file, the custom colour scheme will be prioritized first. If a theme is set in the command-line args, however, it will always be prioritized first.",
"type": [
"string",
"null"
]
"type": ["string", "null"]
},
"widgets": {
"description": "Styling for general widgets.",
@ -928,10 +796,7 @@
},
"bold": {
"description": "Whether to make this text bolded or not. If not set, will default to built-in defaults.",
"type": [
"boolean",
"null"
]
"type": ["boolean", "null"]
},
"color": {
"description": "A built-in ANSI colour, RGB hex, or RGB colour code.",
@ -946,10 +811,7 @@
},
"italics": {
"description": "Whether to make this text italicized or not. If not set, will default to built-in defaults.",
"type": [
"boolean",
"null"
]
"type": ["boolean", "null"]
}
}
}
@ -957,12 +819,7 @@
},
"WidgetBorderType": {
"type": "string",
"enum": [
"Default",
"Rounded",
"Double",
"Thick"
]
"enum": ["Default", "Rounded", "Double", "Thick"]
},
"WidgetStyle": {
"description": "General styling for generic widgets.",
@ -1052,19 +909,13 @@
"type": "object",
"properties": {
"child": {
"type": [
"array",
"null"
],
"type": ["array", "null"],
"items": {
"$ref": "#/definitions/RowChildren"
}
},
"ratio": {
"type": [
"integer",
"null"
],
"type": ["integer", "null"],
"format": "uint32",
"minimum": 0.0
}

2
scripts/windows/choco/bottom.nuspec.template
View File

@ -31,7 +31,7 @@ This is a nuspec. It mostly adheres to https://docs.nuget.org/create/Nuspec-Refe
<requireLicenseAcceptance>true</requireLicenseAcceptance>
<projectSourceUrl>https://github.com/ClementTsang/bottom</projectSourceUrl>
<packageSourceUrl>https://github.com/ClementTsang/choco-bottom</packageSourceUrl>
<docsUrl>https://clementtsang.github.io/bottom/stable</docsUrl>
<docsUrl>https://bottom.pages.dev/stable</docsUrl>
<bugTrackerUrl>https://github.com/ClementTsang/bottom/issues</bugTrackerUrl>
<tags>cli cross-platform terminal top tui monitoring bottom btm</tags>
<summary>A customizable cross-platform graphical process/system monitor for the terminal.</summary>

2
src/bin/schema.rs
View File

@ -53,7 +53,7 @@ fn generate_schema(schema_options: SchemaOptions) -> anyhow::Result<()> {
"https://github.com/ClementTsang/bottom/blob/main/schema/{version}/bottom.json"
));
metadata.description = Some(format!(
"https://clementtsang.github.io/bottom/{}/configuration/config-file",
"https://bottom.pages.dev/{}/configuration/config-file",
if version == "nightly" {
"nightly"
} else {

2
src/lib.rs
View File

@ -5,7 +5,7 @@
//! **Note:** The following documentation is primarily intended for people to
//! refer to for development purposes rather than the actual usage of the
//! application. If you are instead looking for documentation regarding the
//! *usage* of bottom, refer to [here](https://clementtsang.github.io/bottom/stable/).
//! *usage* of bottom, refer to [here](https://bottom.pages.dev/stable/).
pub(crate) mod app;
mod utils {

2
wix/main.wxs
View File

@ -218,7 +218,7 @@
<!--<Icon Id='ProductICO' SourceFile='wix\Product.ico'/>-->
<!--<Property Id='ARPPRODUCTICON' Value='ProductICO' />-->
<Property Id='ARPHELPLINK' Value='https://clementtsang.github.io/bottom/stable'/>
<Property Id='ARPHELPLINK' Value='https://bottom.pages.dev/stable'/>
<UI>
<UIRef Id='WixUI_FeatureTree'/>