tealdeer-rs/tealdeer v1.5.0

Version 1.5.0

on GitHub

This is quite a big release with many new features. In the 15 months since the last release,
59 pull requests from 16 different contributors were merged!

The highlights:

• 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 your own examples. For more
  details, see the docs.
• Change argument parsing from docopt to clap: We replaced docopt.rs as argument
  parsing library with clap v3, resulting in almost 1 MiB smaller binaries and a 22% speed
  increase when rendering a tldr page.
• Multi-language support: You can now override the language with -L/--language.
• A new --show-paths command: By running tldr --show-paths, you can list the currently
  used config dir, cache dir, upstream pages dir and custom pages dir.
• Compliance with the tldr client spec v1.5: We renamed -o/--os to -p/--platform and
  implemented transparent lowercasing of the page names.
• Docs: The README based documentation has reached its limits. There are now new
  mdbook based docs over at dbrgn.github.io/tealdeer/, we hope these make
  using tealdeer easier. Of course, documentation improvements are 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.

Note that the MSRV (Minimal Supported Rust Version) of the project changed:

When publishing a Tealdeer release, the Rust version required to build it
should be stable for at least a month.

For the full changelog, see https://github.com/dbrgn/tealdeer/blob/main/CHANGELOG.md.

Binaries were generated automatically in CI, and are therefore unsigned. For a fully trusted
release, please build from source.