Commit graph

452 commits

Author SHA1 Message Date
Niklas Mohrin
eb0c2345a9
Add readthedocs configuration and update mdbook 2026-08-17 18:35:50 +02:00
Niklas Mohrin
5ddc86ee74
Release v1.6.2 v1.6.2 2026-01-24 01:03:15 +01:00
Niklas Mohrin
22d0889d47
Update ARCHIVE_URL
When this code was written, the client specification instructed clients
that they MUST download pages from the tldr.sh domain. However, this
domain was deprecated and shut down in December 2025.
2026-01-24 01:03:15 +01:00
Niklas Mohrin
4d53377151
Update .github files
Checked out b3cd7b1c21 and performed minor
edits.
2026-01-24 01:03:15 +01:00
Danilo Bargen
7c371a6852 Release v1.6.1 v1.6.1 2022-10-24 14:42:37 +02:00
Danilo Bargen
b10f8a9485
Run cargo update (#299) 2022-10-22 20:24:57 +00:00
Danilo Bargen
ab5148f237
Fix path source for custom pages dir (#297) 2022-10-22 22:00:29 +02:00
Cyrus Yip
86c850282e
Docs: improve grammar (#296) 2022-10-11 12:08:41 +00:00
Danilo Bargen
357f0e7e71 Release v1.6.0 v1.6.0 2022-10-02 00:36:58 +02:00
Danilo Bargen
7ded00eda0
Run cargo update (#291) 2022-10-01 22:23:26 +00:00
Danilo Bargen
6f72ce778d
Merge pull request #290 from dbrgn/remove-deprecated-commands
Remove deprecated commands
2022-10-02 00:05:00 +02:00
Danilo Bargen
2ebf86b265 Remove deprecated -m/--markdown command 2022-10-01 23:54:37 +02:00
Danilo Bargen
efe1b57696 Remove deprecated -o/--os command 2022-10-01 23:53:32 +02:00
Danilo Bargen
0c93a4cfe9 Remove deprecated --config-path command 2022-10-01 23:52:03 +02:00
Danilo Bargen
99c86a4aff
Merge pull request #276 from dbrgn/cache-dir-config
Allow overriding cache directory through config
2022-10-01 12:32:41 +02:00
Danilo Bargen
c44faf2b09 Lazy creation of cache directory 2022-10-01 12:18:44 +02:00
Danilo Bargen
3f528ba5cb Impl From<RawX> for more config types
- StyleConfig
- DisplayConfig
- UpdatesConfig
2022-10-01 12:18:34 +02:00
Danilo Bargen
d702a1fab6 Cache: Add pages_dir helper method
Additionally, rename `cache_dir` to `pages_dir` where terminology was
wrong.
2022-10-01 12:18:34 +02:00
Danilo Bargen
3e7dfb3c71 Cache: Make URL a parameter, not a field 2022-10-01 12:18:33 +02:00
Danilo Bargen
fb89303e85 Move custom_pages_dir business logic from RawConfig to Config
This also introduces the path source information for that directory,
which was previously unknown.
2022-10-01 12:18:30 +02:00
Danilo Bargen
7338933de5 Add integration test for cache_dir 2022-10-01 12:13:40 +02:00
Danilo Bargen
afbdfa6746 Bring back path source for cache directory 2022-10-01 12:13:40 +02:00
Danilo Bargen
33f0f108d8 Allow overriding cache directory through config
- Config: Add `cache_dir` to `[directories]` section
- Logic to handle legacy env var, config override and default cache dir
  selection is now in the `Config::try_from(RawConfig)` impl
- Deprecate old `TEALDEER_CACHE_DIR` env variable
- Update docs

Co-authored-by: Hans Gaiser <hansg91@gmail.com>
2022-10-01 12:13:39 +02:00
Danilo Bargen
026ae72742
Switch from ansi_term to yansi (#288)
ansi_term is not actively maintained anymore (see
https://rustsec.org/advisories/RUSTSEC-2021-0139). Replace it with a
suitable alternative.

I looked at termcolor, owo-colors and yansi and picked yansi:

- It is very simple
- It does not do terminal color support checking (we already do that in
  tealdeer)
- Its color enum type is almost identical to the one from ansi_term, so
  migrating is easy

The only change from a config API point of view is that "purple" is now
renamed to "magenta", but "purple" still works.
2022-09-27 23:55:50 +02:00
Danilo Bargen
f45a502383
Run cargo update (#287) 2022-09-24 20:54:01 +00:00
Olav de Haas
f4a94112f4
Add custom pages to list output (#285)
Fixes #205.
2022-09-24 21:27:35 +02:00
Niklas Mohrin
aa67a59d5b
Merge pull request #284 from niklasmohrin/edition-and-lints
Switch to 2021 Edition and maintenance
2022-08-21 23:18:39 +02:00
Niklas Mohrin
65cbe80e9d
Add comment to empty rustfmt.toml 2022-08-21 22:39:02 +02:00
Niklas Mohrin
a6023a5234
Small fixes in ci.yml
- Add `profile: minimal`
- Install `rustfmt` when installing the toolchain, not afterwards
- Use stable toolchain for `rustfmt`
- Replace `override` with `default`. I think this better reflects the
  "use what we just installed" intent.
2022-08-21 22:39:02 +02:00
Niklas Mohrin
db492bc0cf
Upgrade to 2021 edition of Rust
To do so, we need to bump the MSRV to 1.56 (released 10/2021). While at
it, I actually bumped it all the way to 1.62, where the latest version,
(1.62.1) has been released on July 19, which is just more than one month
ago. Additionally, I removed `clippy.toml` and instead specified the
MSRV in `Cargo.toml`. This will also print an error when trying to
compile with an older compiler.
2022-08-21 22:32:07 +02:00
Niklas Mohrin
e94ee92db4
cargo clippy --fix 2022-08-21 21:53:10 +02:00
bagohart
b369678794
added missing fish completion for language (#280) 2022-07-18 10:01:03 +00:00
Kian-Meng Ang
97b4395e25
Fix typos (#277) 2022-06-20 12:35:17 +00:00
Danilo Bargen
543fa2290d
Merge pull request #274 from newsch/android-platform
Add support for Android platform
2022-06-14 23:11:08 +02:00
Evan Lloyd New-Schmidt
abbbbf01ed Add PlatformType::current for android target 2022-06-14 15:50:18 -04:00
Evan Lloyd New-Schmidt
4a5410fd0b Add support for android platform
tldr added android-specific commands under a new 'android' platform
last year: <https://github.com/tldr-pages/tldr/issues/5462>
2022-06-02 12:36:20 -04:00
Danilo Bargen
0f82aa5950
Create macOS release builds with bundled root certificates (#272)
As reported in https://github.com/dbrgn/tealdeer/issues/244, some users
on macOS had problems with `rustls-tls-native-roots`. Since we did not
find the root cause of this, we'll build macOS release builds with
`rustls-tls-webpki-roots` instead.

Fixes #244.
2022-05-06 10:43:30 +00:00
Danilo Bargen
d138ce23e4
Merge pull request #271 from dbrgn/updates
Updates
2022-05-03 22:54:56 +02:00
Danilo Bargen
750ebf653c CI: Bump rustfmt toolchain to 1.60 2022-05-03 22:31:58 +02:00
Danilo Bargen
62b6405685 Fix clap deprecation warnings 2022-05-03 22:10:18 +02:00
Danilo Bargen
3629002d5c Upgrade zip: 0.5 → 0.6 2022-05-03 21:49:44 +02:00
Danilo Bargen
6e09af2f8b Run cargo update 2022-05-03 21:47:15 +02:00
Simon Perdrisat
786933e507
Docs: Add MacPorts in the list of package managers (#270) 2022-04-09 15:10:22 +00:00
Danilo Bargen
5a1a21b8ab
Add note about auto-updates when cache is missing (#254) 2022-02-06 22:53:48 +01:00
Danilo Bargen
716ff15779
Merge pull request #262 from dbrgn/fix-completions
Clean up shell completions
2022-01-22 01:31:51 +01:00
Danilo Bargen
cc22760e5a Align help text and completion descriptions 2022-01-21 09:15:52 +01:00
Danilo Bargen
cab6666ffb Fix completions: Remove -p for pager 2022-01-21 09:14:30 +01:00
cyqsimon
d5dbe3084b
Add no-auto-update flag (#257)
* Added `no-auto-update`
* Updated usage.txt
* Add `no-auto-update` to completion scripts
* Apply review suggestions
2022-01-21 09:12:10 +01:00
Danny Moesch
2177297871
Move shell completion scripts to their own directory (#259)
* Move shell completion scripts to their own directory
* Remove completion scripts from published Cargo package
2022-01-20 09:10:18 +01:00
Danny Moesch
3b4451f8fa
Move definition of CLI arguments and options into own file (#258) 2022-01-19 23:49:23 +01:00