Update all URLs to point to new GitHub organization (#379)

See https://github.com/tealdeer-rs/tealdeer/issues/376 for details.
This commit is contained in:
Danilo Bargen 2024-09-30 11:27:19 +02:00 committed by GitHub
commit fc6d644152
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
12 changed files with 97 additions and 97 deletions

View file

@ -14,7 +14,7 @@ jobs:
run: | run: |
source ./scripts/upload-asset.sh source ./scripts/upload-asset.sh
# Create: <token> <repo> <tag> # Create: <token> <repo> <tag>
create_release ${{ secrets.GITHUB_TOKEN }} ${{ github.repository }} ${GITHUB_REF#refs/*/} "Tealdeer version ${GITHUB_REF#refs/*/v}.\n\nFor the full changelog, see https://github.com/dbrgn/tealdeer/blob/main/CHANGELOG.md.\n\nBinaries were generated automatically in CI, and are therefore unsigned. For a fully trusted release, please build from source." create_release ${{ secrets.GITHUB_TOKEN }} ${{ github.repository }} ${GITHUB_REF#refs/*/} "Tealdeer version ${GITHUB_REF#refs/*/v}.\n\nFor the full changelog, see https://github.com/tealdeer-rs/tealdeer/blob/main/CHANGELOG.md.\n\nBinaries were generated automatically in CI, and are therefore unsigned. For a fully trusted release, please build from source."
upload-completions: upload-completions:
needs: needs:

View file

@ -88,7 +88,7 @@ The highlights:
- **Custom pages and patches**: You can now create your own local-only tldr - **Custom pages and patches**: You can now create your own local-only tldr
pages. But not just that, you can also extend existing upstream pages with pages. But not just that, you can also extend existing upstream pages with
your own examples. For more details, see your own examples. For more details, see
[the docs](https://dbrgn.github.io/tealdeer/usage_custom_pages.html). [the docs](https://tealdeer-rs.github.io/tealdeer/usage_custom_pages.html).
- **Change argument parsing from docopt to clap**: We replaced docopt.rs as - **Change argument parsing from docopt to clap**: We replaced docopt.rs as
argument parsing library with clap v3, resulting in almost 1 MiB smaller argument parsing library with clap v3, resulting in almost 1 MiB smaller
binaries and a 22% speed increase when rendering a tldr page. binaries and a 22% speed increase when rendering a tldr page.
@ -99,7 +99,7 @@ The highlights:
`-p/--platform` and implemented transparent lowercasing of the page names. `-p/--platform` and implemented transparent lowercasing of the page names.
- **Docs**: The README based documentation has reached its limits. There are - **Docs**: The README based documentation has reached its limits. There are
now new mdbook based docs over at now new mdbook based docs over at
[dbrgn.github.io/tealdeer/](https://dbrgn.github.io/tealdeer/), we hope these [tealdeer-rs.github.io/tealdeer/](https://tealdeer-rs.github.io/tealdeer/), we hope these
make using tealdeer easier. Of course, documentation improvements are make using tealdeer easier. Of course, documentation improvements are
welcome! Also, if you're confused about how to use a certain feature, feel welcome! Also, if you're confused about how to use a certain feature, feel
free to open an issue, this way we can improve the docs. free to open an issue, this way we can improve the docs.
@ -133,8 +133,8 @@ Changes:
- [deprecated] The `--config-path` command is deprecated, use `--show-paths` instead ([#162][i162]) - [deprecated] The `--config-path` command is deprecated, use `--show-paths` instead ([#162][i162])
- [deprecated] The `-o/--os` command is deprecated, use `-p/--platform` instead ([#217][i217]) - [deprecated] The `-o/--os` command is deprecated, use `-p/--platform` instead ([#217][i217])
- [deprecated] The `-m/--markdown` command is deprecated, use `-r/--raw` instead ([#108][i108]) - [deprecated] The `-m/--markdown` command is deprecated, use `-r/--raw` instead ([#108][i108])
- [docs] New docs at [dbrgn.github.io/tealdeer/](https://dbrgn.github.io/tealdeer/) - [docs] New docs at [tealdeer-rs.github.io/tealdeer/](https://tealdeer-rs.github.io/tealdeer/)
- [docs] Add comparative benchmarks with hyperfine ([#163][i163], [README](https://github.com/dbrgn/tealdeer#goals)) - [docs] Add comparative benchmarks with hyperfine ([#163][i163], [README](https://github.com/tealdeer-rs/tealdeer#goals))
- [chore] Download tldr pages archive from their website, not from GitHub ([#213][i213]) - [chore] Download tldr pages archive from their website, not from GitHub ([#213][i213])
- [chore] Bump MSRV to 1.54 and change MSRV policy ([#190][i190]) - [chore] Bump MSRV to 1.54 and change MSRV policy ([#190][i190])
- [chore] The `master` branch was renamed to `main` - [chore] The `master` branch was renamed to `main`
@ -345,78 +345,78 @@ Thanks!
[@tveness]: https://github.com/tveness [@tveness]: https://github.com/tveness
[@Voultapher]: https://github.com/Voultapher [@Voultapher]: https://github.com/Voultapher
[v1.0.0]: https://github.com/dbrgn/tealdeer/compare/v0.4.0...v1.0.0 [v1.0.0]: https://github.com/tealdeer-rs/tealdeer/compare/v0.4.0...v1.0.0
[v1.1.0]: https://github.com/dbrgn/tealdeer/compare/v1.0.0...v1.1.0 [v1.1.0]: https://github.com/tealdeer-rs/tealdeer/compare/v1.0.0...v1.1.0
[v1.2.0]: https://github.com/dbrgn/tealdeer/compare/v1.1.0...v1.2.0 [v1.2.0]: https://github.com/tealdeer-rs/tealdeer/compare/v1.1.0...v1.2.0
[v1.3.0]: https://github.com/dbrgn/tealdeer/compare/v1.2.0...v1.3.0 [v1.3.0]: https://github.com/tealdeer-rs/tealdeer/compare/v1.2.0...v1.3.0
[v1.4.0]: https://github.com/dbrgn/tealdeer/compare/v1.3.0...v1.4.0 [v1.4.0]: https://github.com/tealdeer-rs/tealdeer/compare/v1.3.0...v1.4.0
[v1.4.1]: https://github.com/dbrgn/tealdeer/compare/v1.4.0...v1.4.1 [v1.4.1]: https://github.com/tealdeer-rs/tealdeer/compare/v1.4.0...v1.4.1
[v1.5.0]: https://github.com/dbrgn/tealdeer/compare/v1.4.1...v1.5.0 [v1.5.0]: https://github.com/tealdeer-rs/tealdeer/compare/v1.4.1...v1.5.0
[v1.6.0]: https://github.com/dbrgn/tealdeer/compare/v1.5.0...v1.6.0 [v1.6.0]: https://github.com/tealdeer-rs/tealdeer/compare/v1.5.0...v1.6.0
[v1.6.1]: https://github.com/dbrgn/tealdeer/compare/v1.6.0...v1.6.1 [v1.6.1]: https://github.com/tealdeer-rs/tealdeer/compare/v1.6.0...v1.6.1
[i34]: https://github.com/dbrgn/tealdeer/issues/34 [i34]: https://github.com/tealdeer-rs/tealdeer/issues/34
[i43]: https://github.com/dbrgn/tealdeer/issues/43 [i43]: https://github.com/tealdeer-rs/tealdeer/issues/43
[i44]: https://github.com/dbrgn/tealdeer/issues/44 [i44]: https://github.com/tealdeer-rs/tealdeer/issues/44
[i47]: https://github.com/dbrgn/tealdeer/issues/47 [i47]: https://github.com/tealdeer-rs/tealdeer/issues/47
[i48]: https://github.com/dbrgn/tealdeer/issues/48 [i48]: https://github.com/tealdeer-rs/tealdeer/issues/48
[i57]: https://github.com/dbrgn/tealdeer/issues/57 [i57]: https://github.com/tealdeer-rs/tealdeer/issues/57
[i58]: https://github.com/dbrgn/tealdeer/issues/58 [i58]: https://github.com/tealdeer-rs/tealdeer/issues/58
[i61]: https://github.com/dbrgn/tealdeer/issues/61 [i61]: https://github.com/tealdeer-rs/tealdeer/issues/61
[i68]: https://github.com/dbrgn/tealdeer/issues/68 [i68]: https://github.com/tealdeer-rs/tealdeer/issues/68
[i69]: https://github.com/dbrgn/tealdeer/issues/69 [i69]: https://github.com/tealdeer-rs/tealdeer/issues/69
[i71]: https://github.com/dbrgn/tealdeer/issues/71 [i71]: https://github.com/tealdeer-rs/tealdeer/issues/71
[i75]: https://github.com/dbrgn/tealdeer/issues/75 [i75]: https://github.com/tealdeer-rs/tealdeer/issues/75
[i77]: https://github.com/dbrgn/tealdeer/issues/77 [i77]: https://github.com/tealdeer-rs/tealdeer/issues/77
[i84]: https://github.com/dbrgn/tealdeer/issues/84 [i84]: https://github.com/tealdeer-rs/tealdeer/issues/84
[i86]: https://github.com/dbrgn/tealdeer/issues/86 [i86]: https://github.com/tealdeer-rs/tealdeer/issues/86
[i87]: https://github.com/dbrgn/tealdeer/issues/87 [i87]: https://github.com/tealdeer-rs/tealdeer/issues/87
[i89]: https://github.com/dbrgn/tealdeer/issues/89 [i89]: https://github.com/tealdeer-rs/tealdeer/issues/89
[i95]: https://github.com/dbrgn/tealdeer/issues/95 [i95]: https://github.com/tealdeer-rs/tealdeer/issues/95
[i97]: https://github.com/dbrgn/tealdeer/issues/97 [i97]: https://github.com/tealdeer-rs/tealdeer/issues/97
[i99]: https://github.com/dbrgn/tealdeer/issues/99 [i99]: https://github.com/tealdeer-rs/tealdeer/issues/99
[i108]: https://github.com/dbrgn/tealdeer/pull/108 [i108]: https://github.com/tealdeer-rs/tealdeer/pull/108
[i111]: https://github.com/dbrgn/tealdeer/issues/111 [i111]: https://github.com/tealdeer-rs/tealdeer/issues/111
[i112]: https://github.com/dbrgn/tealdeer/issues/112 [i112]: https://github.com/tealdeer-rs/tealdeer/issues/112
[i113]: https://github.com/dbrgn/tealdeer/issues/113 [i113]: https://github.com/tealdeer-rs/tealdeer/issues/113
[i115]: https://github.com/dbrgn/tealdeer/issues/115 [i115]: https://github.com/tealdeer-rs/tealdeer/issues/115
[i125]: https://github.com/dbrgn/tealdeer/pull/125 [i125]: https://github.com/tealdeer-rs/tealdeer/pull/125
[i138]: https://github.com/dbrgn/tealdeer/issues/138 [i138]: https://github.com/tealdeer-rs/tealdeer/issues/138
[i142]: https://github.com/dbrgn/tealdeer/pull/142 [i142]: https://github.com/tealdeer-rs/tealdeer/pull/142
[i148]: https://github.com/dbrgn/tealdeer/pull/148 [i148]: https://github.com/tealdeer-rs/tealdeer/pull/148
[i157]: https://github.com/dbrgn/tealdeer/pull/157 [i157]: https://github.com/tealdeer-rs/tealdeer/pull/157
[i161]: https://github.com/dbrgn/tealdeer/pull/161 [i161]: https://github.com/tealdeer-rs/tealdeer/pull/161
[i162]: https://github.com/dbrgn/tealdeer/pull/162 [i162]: https://github.com/tealdeer-rs/tealdeer/pull/162
[i163]: https://github.com/dbrgn/tealdeer/pull/163 [i163]: https://github.com/tealdeer-rs/tealdeer/pull/163
[i168]: https://github.com/dbrgn/tealdeer/pull/168 [i168]: https://github.com/tealdeer-rs/tealdeer/pull/168
[i171]: https://github.com/dbrgn/tealdeer/pull/171 [i171]: https://github.com/tealdeer-rs/tealdeer/pull/171
[i174]: https://github.com/dbrgn/tealdeer/pull/174 [i174]: https://github.com/tealdeer-rs/tealdeer/pull/174
[i176]: https://github.com/dbrgn/tealdeer/pull/176 [i176]: https://github.com/tealdeer-rs/tealdeer/pull/176
[i187]: https://github.com/dbrgn/tealdeer/pull/187 [i187]: https://github.com/tealdeer-rs/tealdeer/pull/187
[i190]: https://github.com/dbrgn/tealdeer/issues/190 [i190]: https://github.com/tealdeer-rs/tealdeer/issues/190
[i197]: https://github.com/dbrgn/tealdeer/pull/197 [i197]: https://github.com/tealdeer-rs/tealdeer/pull/197
[i210]: https://github.com/dbrgn/tealdeer/pull/210 [i210]: https://github.com/tealdeer-rs/tealdeer/pull/210
[i213]: https://github.com/dbrgn/tealdeer/pull/213 [i213]: https://github.com/tealdeer-rs/tealdeer/pull/213
[i215]: https://github.com/dbrgn/tealdeer/pull/215 [i215]: https://github.com/tealdeer-rs/tealdeer/pull/215
[i217]: https://github.com/dbrgn/tealdeer/pull/217 [i217]: https://github.com/tealdeer-rs/tealdeer/pull/217
[i227]: https://github.com/dbrgn/tealdeer/pull/227 [i227]: https://github.com/tealdeer-rs/tealdeer/pull/227
[#231]: https://github.com/dbrgn/tealdeer/pull/231 [#231]: https://github.com/tealdeer-rs/tealdeer/pull/231
[i240]: https://github.com/dbrgn/tealdeer/pull/240 [i240]: https://github.com/tealdeer-rs/tealdeer/pull/240
[#247]: https://github.com/dbrgn/tealdeer/pull/247 [#247]: https://github.com/tealdeer-rs/tealdeer/pull/247
[#249]: https://github.com/dbrgn/tealdeer/pull/249 [#249]: https://github.com/tealdeer-rs/tealdeer/pull/249
[#253]: https://github.com/dbrgn/tealdeer/pull/253 [#253]: https://github.com/tealdeer-rs/tealdeer/pull/253
[#254]: https://github.com/dbrgn/tealdeer/pull/254 [#254]: https://github.com/tealdeer-rs/tealdeer/pull/254
[#257]: https://github.com/dbrgn/tealdeer/pull/257 [#257]: https://github.com/tealdeer-rs/tealdeer/pull/257
[#259]: https://github.com/dbrgn/tealdeer/pull/259 [#259]: https://github.com/tealdeer-rs/tealdeer/pull/259
[#262]: https://github.com/dbrgn/tealdeer/pull/262 [#262]: https://github.com/tealdeer-rs/tealdeer/pull/262
[#271]: https://github.com/dbrgn/tealdeer/pull/271 [#271]: https://github.com/tealdeer-rs/tealdeer/pull/271
[#272]: https://github.com/dbrgn/tealdeer/pull/272 [#272]: https://github.com/tealdeer-rs/tealdeer/pull/272
[#274]: https://github.com/dbrgn/tealdeer/pull/274 [#274]: https://github.com/tealdeer-rs/tealdeer/pull/274
[#276]: https://github.com/dbrgn/tealdeer/pull/276 [#276]: https://github.com/tealdeer-rs/tealdeer/pull/276
[#284]: https://github.com/dbrgn/tealdeer/pull/284 [#284]: https://github.com/tealdeer-rs/tealdeer/pull/284
[#285]: https://github.com/dbrgn/tealdeer/pull/285 [#285]: https://github.com/tealdeer-rs/tealdeer/pull/285
[#287]: https://github.com/dbrgn/tealdeer/pull/287 [#287]: https://github.com/tealdeer-rs/tealdeer/pull/287
[#290]: https://github.com/dbrgn/tealdeer/pull/290 [#290]: https://github.com/tealdeer-rs/tealdeer/pull/290
[#291]: https://github.com/dbrgn/tealdeer/pull/291 [#291]: https://github.com/tealdeer-rs/tealdeer/pull/291
[#297]: https://github.com/dbrgn/tealdeer/pull/297 [#297]: https://github.com/tealdeer-rs/tealdeer/pull/297
[#299]: https://github.com/dbrgn/tealdeer/pull/299 [#299]: https://github.com/tealdeer-rs/tealdeer/pull/299

View file

@ -4,12 +4,12 @@ authors = [
"Niklas Mohrin <dev@niklasmohrin.de>", "Niklas Mohrin <dev@niklasmohrin.de>",
] ]
description = "Fetch and show tldr help pages for many CLI commands. Full featured offline client with caching support." description = "Fetch and show tldr help pages for many CLI commands. Full featured offline client with caching support."
homepage = "https://github.com/dbrgn/tealdeer/" homepage = "https://github.com/tealdeer-rs/tealdeer/"
license = "MIT OR Apache-2.0" license = "MIT OR Apache-2.0"
name = "tealdeer" name = "tealdeer"
readme = "README.md" readme = "README.md"
repository = "https://github.com/dbrgn/tealdeer/" repository = "https://github.com/tealdeer-rs/tealdeer/"
documentation = "https://dbrgn.github.io/tealdeer/" documentation = "https://tealdeer-rs.github.io/tealdeer/"
version = "1.6.1" version = "1.6.1"
include = ["/src/**/*", "/tests/**/*", "/Cargo.toml", "/README.md", "/LICENSE-*", "/screenshot.png", "completion/*"] include = ["/src/**/*", "/tests/**/*", "/Cargo.toml", "/README.md", "/LICENSE-*", "/screenshot.png", "completion/*"]
rust-version = "1.75" rust-version = "1.75"

View file

@ -14,12 +14,12 @@ Rust: Simplified, example based and community-driven man pages.
If you pronounce "tldr" in English, it sounds somewhat like "tealdeer". Hence the project name :) If you pronounce "tldr" in English, it sounds somewhat like "tealdeer". Hence the project name :)
In case you're in a hurry and just want to quickly try tealdeer, you can find static In case you're in a hurry and just want to quickly try tealdeer, you can find static
binaries on the [GitHub releases page](https://github.com/dbrgn/tealdeer/releases/)! binaries on the [GitHub releases page](https://github.com/tealdeer-rs/tealdeer/releases/)!
## Docs (Installing, Usage, Configuration) ## Docs (Installing, Usage, Configuration)
User documentation is available at <https://dbrgn.github.io/tealdeer/>! User documentation is available at <https://tealdeer-rs.github.io/tealdeer/>!
The docs are generated using [mdbook](https://rust-lang.github.io/mdBook/index.html). The docs are generated using [mdbook](https://rust-lang.github.io/mdBook/index.html).
They can be edited through the markdown files in the `docs/src/` directory. They can be edited through the markdown files in the `docs/src/` directory.
@ -120,13 +120,13 @@ Thanks to @severen for coming up with the name "tealdeer"!
[outfieldr-gh]: https://gitlab.com/ve-nt/outfieldr [outfieldr-gh]: https://gitlab.com/ve-nt/outfieldr
[python-gh]: https://github.com/tldr-pages/tldr-python-client [python-gh]: https://github.com/tldr-pages/tldr-python-client
[benchmark-dockerfile]: https://github.com/dbrgn/tealdeer/blob/main/benchmarks/Dockerfile [benchmark-dockerfile]: https://github.com/tealdeer-rs/tealdeer/blob/main/benchmarks/Dockerfile
[client-spec]: https://github.com/tldr-pages/tldr/blob/main/CLIENT-SPECIFICATION.md [client-spec]: https://github.com/tldr-pages/tldr/blob/main/CLIENT-SPECIFICATION.md
[hyperfine-gh]: https://github.com/sharkdp/hyperfine [hyperfine-gh]: https://github.com/sharkdp/hyperfine
[outfieldr-comment-tls]: https://github.com/dbrgn/tealdeer/issues/129#issuecomment-833596765 [outfieldr-comment-tls]: https://github.com/tealdeer-rs/tealdeer/issues/129#issuecomment-833596765
<!-- Badges --> <!-- Badges -->
[github-actions]: https://github.com/dbrgn/tealdeer/actions?query=branch%3Amain [github-actions]: https://github.com/tealdeer-rs/tealdeer/actions?query=branch%3Amain
[github-actions-badge]: https://github.com/dbrgn/tealdeer/actions/workflows/ci.yml/badge.svg?branch=main [github-actions-badge]: https://github.com/tealdeer-rs/tealdeer/actions/workflows/ci.yml/badge.svg?branch=main
[crates-io]: https://crates.io/crates/tealdeer [crates-io]: https://crates.io/crates/tealdeer
[crates-io-badge]: https://img.shields.io/crates/v/tealdeer.svg [crates-io-badge]: https://img.shields.io/crates/v/tealdeer.svg

View file

@ -18,7 +18,7 @@
FROM rust AS tealdeer-builder FROM rust AS tealdeer-builder
WORKDIR /build WORKDIR /build
RUN git clone https://github.com/dbrgn/tealdeer.git \ RUN git clone https://github.com/tealdeer-rs/tealdeer.git \
&& cd tealdeer \ && cd tealdeer \
&& cargo build --release \ && cargo build --release \
&& mkdir /build-outputs \ && mkdir /build-outputs \

View file

@ -1,6 +1,6 @@
# #
# Completions for the tealdeer implementation of tldr # Completions for the tealdeer implementation of tldr
# https://github.com/dbrgn/tealdeer/ # https://github.com/tealdeer-rs/tealdeer/
# #
complete -c tldr -s h -l help -d 'Print the help message.' -f complete -c tldr -s h -l help -d 'Print the help message.' -f

View file

@ -31,7 +31,7 @@ Tealdeer has been added to a few package managers:
## Static Binaries (Linux) ## Static Binaries (Linux)
Static binary builds (currently for Linux only) are available on the Static binary builds (currently for Linux only) are available on the
[GitHub releases page](https://github.com/dbrgn/tealdeer/releases). [GitHub releases page](https://github.com/tealdeer-rs/tealdeer/releases).
Simply download the binary for your platform and run it! Simply download the binary for your platform and run it!
## Through `cargo install` ## Through `cargo install`

View file

@ -10,5 +10,5 @@ This documentation shows how to install, use and configure tealdeer.
## Links ## Links
- [GitHub Project Page](https://github.com/dbrgn/tealdeer) - [GitHub Project Page](https://github.com/tealdeer-rs/tealdeer)
- [TLDR Pages Project](https://tldr.sh/) - [TLDR Pages Project](https://tldr.sh/)

View file

@ -49,4 +49,4 @@ every page, so the script may take a couple of seconds to finish.
## Extending this chapter ## Extending this chapter
If you have an interesting setup with Tealdeer, feel free to share your If you have an interesting setup with Tealdeer, feel free to share your
configuration on [our Github repository](https://github.com/dbrgn/tealdeer). configuration on [our Github repository](https://github.com/tealdeer-rs/tealdeer).

View file

@ -25,4 +25,4 @@ Options:
-v, --version Print the version -v, --version Print the version
-h, --help Print help -h, --help Print help
To view the user documentation, please visit https://dbrgn.github.io/tealdeer/. To view the user documentation, please visit https://tealdeer-rs.github.io/tealdeer/.

View file

@ -18,7 +18,7 @@ use crate::types::{ColorOptions, PlatformType};
{usage-heading} {usage} {usage-heading} {usage}
{all-args}{after-help}", {all-args}{after-help}",
after_help = "To view the user documentation, please visit https://dbrgn.github.io/tealdeer/.", after_help = "To view the user documentation, please visit https://tealdeer-rs.github.io/tealdeer/.",
arg_required_else_help = true, arg_required_else_help = true,
help_expected = true, help_expected = true,
group = ArgGroup::new("command_or_file").args(&["command", "render"]), group = ArgGroup::new("command_or_file").args(&["command", "render"]),

View file

@ -110,7 +110,7 @@ fn check_cache(cache: &Cache, args: &Cli, enable_styles: bool) -> CheckCacheResu
println!("The path to your config file can be looked up with `tldr --show-paths`."); println!("The path to your config file can be looked up with `tldr --show-paths`.");
println!("To create an initial config file, use `tldr --seed-config`.\n"); println!("To create an initial config file, use `tldr --seed-config`.\n");
println!("You can find more tips and tricks in our docs:\n"); println!("You can find more tips and tricks in our docs:\n");
println!(" https://dbrgn.github.io/tealdeer/config_updates.html"); println!(" https://tealdeer-rs.github.io/tealdeer/config_updates.html");
CheckCacheResult::CacheMissing CheckCacheResult::CacheMissing
} }
} }