Commit graph

69 commits

Author SHA1 Message Date
Nikolaos Karaolidis
f8a2003bc2
Add updates.warn_cache_age config option (#492)
This is useful when the cache is managed externally, e.g. provisioned
from a Nix store path or by a package manager, where the directory's
mtime doesn't reflect the cache's real age, causing a spurious warning
on every invocation. Today the only way to silence it is `--quiet`,
which must be passed every call and hides all other output too.
2026-07-07 14:24:06 +02:00
Pavel Timofeev
b8f7c0cc2d
Add display.indent config option (#471)
Fixes #394.
2026-04-17 21:59:34 +02:00
Pavel Timofeev
b19517097a
Add builtin tldr tealdeer page (#472)
Fixes #218.
2026-04-14 00:31:31 +02:00
Niklas Mohrin
b3cd7b1c21
Release v1.8.1 2025-11-11 22:27:52 +01:00
Niklas Mohrin
d49c4a9e05
Release v1.8.0 2025-10-03 22:59:18 +02:00
Niklas Mohrin
2b127fd67e
Highlight code examples in user docs (#440)
* Highlight code examples in user docs
* Add missing quotes to archive_source example
2025-10-03 20:59:22 +02:00
Niklas Mohrin
911508ce33
Add search.platforms config option and search all platforms by default (#435) 2025-10-03 20:15:34 +02:00
hex1c
5b306756af
Add display.show_title option to display command titles in output (#439) 2025-10-03 19:53:25 +02:00
Niklas Mohrin
c741146db5
Add updates.download_languages setting 2025-09-22 00:00:09 +02:00
Niklas Mohrin
a74b7120bd
Add search.languages setting 2025-09-21 23:59:50 +02:00
MHS-0
9bb95ad11d
Add an option to specify a custom config file to be used (#422)
Co-authored-by: Niklas Mohrin <dev@niklasmohrin.de>
2025-05-31 21:43:39 +02:00
Niklas Mohrin
769ef4da20
Merge branch 'v1.7.x' 2025-03-18 23:51:51 +01:00
Niklas Mohrin
8f433e7774
Release v1.7.2 2025-03-18 23:38:12 +01:00
lyj
55f401df30
Add args: --edit-page and --edit-patch (#388)
Fix https://github.com/tealdeer-rs/tealdeer/issues/383

Co-authored-by: Niklas Mohrin <dev@niklasmohrin.de>
2025-02-26 22:03:18 +01:00
Erick Guan
09ef7f534e
Allow configuring TLS backend (#386) 2025-02-26 00:27:44 +01:00
Predrag Minic
120e2a92c2
Add configuration option for archive_source (#337)
This allows for specifying a custom archive URL as an alternative approach to Custom Pages.

Co-authored-by: Niklas Mohrin <dev@niklasmohrin.de>
2025-01-12 12:24:02 +01:00
Christoph Loy
b9f116d629
Add common platform to CLI (#401) 2025-01-12 11:50:32 +01:00
Niklas Mohrin
1d9153e37e
Release v1.7.1 2024-11-14 22:11:34 +01:00
Danilo Bargen
d44613cf59 Release v1.7.0 2024-10-02 23:02:32 +02:00
Danilo Bargen
fc6d644152
Update all URLs to point to new GitHub organization (#379)
See https://github.com/tealdeer-rs/tealdeer/issues/376 for details.
2024-09-30 11:27:19 +02:00
Danilo Bargen
7c245040b9
Command line help: Add hint about platform overrides (#375)
- Rename PLATFORMS to PLATFORM
- Add hint about specifying platform multiple times
2024-08-13 00:14:19 +02:00
Danilo Bargen
de1684edb6 Update to clap v4 2024-06-17 00:35:04 +02:00
K.B.Dharun Krishna
ee6d2418f1
Add BSD platform support and update workflows (#354) 2024-04-10 16:05:51 +02:00
Zacchary Dempsey-Plante
17c08f0261
Change custom page files to use a .md extension (#322)
* Change custom page files to use a `.md` extension.
* Add a breaking change warning to the documentation for the usage of custom pages.
* Add a temporary check for old custom pages to assist in the migration to the new naming convention.

Co-authored-by: Danilo Bargen <mail@dbrgn.ch>
2024-02-15 19:27:56 +00:00
Zacchary Dempsey-Plante
ad69985e42
Update the Nix package link in the documentation (#353) 2024-02-11 20:58:06 +00:00
Felix Yan
5bdcd6ae9c
Update Arch Linux package URL in installing.md (#348)
The old URL returns 404 now.
2023-11-21 12:34:22 +01:00
Niklas Mohrin
a82bc4b8d2
Add "Tips and Tricks" chapter to user manual (#342) 2023-10-02 21:06:09 +02:00
JJ Style
9e1489bbc5
Allow querying multiple platforms (#300) 2023-08-27 21:52:20 +00:00
Danilo Bargen
fb755ba8dc Docs: Consistent capitalization of tealdeer
Capitalize at the start of a sentence, lowercase otherwise.
2023-02-12 18:54:05 +01:00
Danilo Bargen
c9ec88354a Docs: Remove section about overriding cache dir
The env var `TEALDEER_CACHE_DIR` is deprecated. The new way to configure
the cache dir is documented in the "[directories]" section.
2023-02-12 18:49:39 +01:00
Danilo Bargen
74d1ade884 Docs: Mention building with bundled roots 2023-02-12 18:49:39 +01:00
Danilo Bargen
b07a6728f3 Docs: Remove note about OpenSSL
OpenSSL is not used anymore since version 1.5.0.
2023-02-12 18:49:39 +01:00
Blair Noctis
0c8cb42664
Docs: Add Debian to packaged list (#315) 2023-02-10 22:28:45 +00:00
Y.D.X
c077ff05e4
Docs: Fix typo (irregular space → regular space) (#310)
It was a no-break space (U+00A0), which causes mdBook to ignore the line break and [render wrongly](https://dbrgn.github.io/tealdeer/installing.html#package-managers).

Instead, a regular space (U+0020) should be used.
2023-01-11 10:22:49 +00:00
Mohit Raj
fc8266d1c9
Docs: Add scoop package manager as supported installation method (#305) 2022-12-18 23:40:27 +01:00
Danilo Bargen
7c371a6852 Release v1.6.1 2022-10-24 14:42:37 +02:00
Cyrus Yip
86c850282e
Docs: improve grammar (#296) 2022-10-11 12:08:41 +00:00
Danilo Bargen
357f0e7e71 Release v1.6.0 2022-10-02 00:36:58 +02:00
Danilo Bargen
0c93a4cfe9 Remove deprecated --config-path command 2022-10-01 23:52:03 +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
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
Simon Perdrisat
786933e507
Docs: Add MacPorts in the list of package managers (#270) 2022-04-09 15:10:22 +00: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
Danilo Bargen
47a4d6d7ca Docs: Remove note about patch concatenation (#245) 2022-01-02 02:04:52 +01:00
Danilo Bargen
81c30bfb77 Release v1.5.0 2021-12-31 23:04:51 +01:00
Danilo Bargen
20b7c5c33f Run cargo update 2021-12-31 18:53:56 +01:00
Danilo Bargen
2b1167f19b Update custom patches docs 2021-12-30 00:12:51 +01:00
Danilo Bargen
ca844b35e9 Docs: Document custom pages and patches 2021-12-20 01:05:24 +01:00