ceos/tealdeer
1
0
Fork 0
mirror of https://github.com/tealdeer-rs/tealdeer.git synced 2026-08-18 22:24:18 +02:00
Code Issues Projects Releases Packages Wiki Activity
485 commits 11 branches 20 tags 4.5 MiB
Commit graph

48 commits

Author SHA1 Message Date
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
Danilo Bargen
abeb5c3757 Docs: Add directories config section 2021-12-20 01:05:24 +01:00
Danilo Bargen
66255219fa Docs: Improve structure of config docs 2021-12-20 01:05:21 +01:00
Danilo Bargen
69f4808214 Clap: Hide deprecated -o/--os argument from help 2021-12-11 18:00:19 +01:00
Danilo Bargen
72d753c52b
 		Add "macos" alias for "osx" (#215) 
The Apple computer operating system was renamed from "OS X" to "macOS"
in 2016. We should accept "macos" instead of "osx" in all our CLI APIs,
and the docs should also mention this alias instead of "osx".

For backwards compatibility and for compatibility with the tldr client
specification, we should still accept "osx" though.
 2021-12-05 16:38:35 +01:00
Danilo Bargen
0fbc95cb71
 		Rename -o / --os to -p / --platform (#217) 
This makes it compliant with the client spec.

The `-p` flag was previously used for the pager, using the pager now
requires using the long flag (`--pager`). Alternatively the pager can be
configured through the config file.

This commit also renames OsType to PlatformType.
 2021-12-05 13:28:58 +01:00
Marcin Puc
3beed4ad48
 		Simplify clap derive definition (#221) 
- Use `possible_values`
- Change `render` field type to `PathBuf`
- Add comment about explicit field names
 2021-10-24 23:17:43 +02:00
Danilo Bargen
618ecaf71f Add @niklasmohrin to crate authors 2021-10-17 22:23:35 +02:00
Danilo Bargen
371f1d2ace Help: Add a link to the online docs 2021-10-17 22:22:45 +02:00
Danilo Bargen
8833b6b401 Rename -m / --markdown to -r / --raw 
That flag name is clearer: We output raw page data without processing.
 2021-10-17 21:12:08 +02:00
Danilo Bargen
5ad7dcfa34 Argument parsing: Switch from docopt to clap 2021-10-17 21:12:08 +02:00
Tsvetomir Bonev
3f49100307
 		Docs: Add funtoo package to list (#208) 2021-10-03 16:10:30 +02:00
Danilo Bargen
49f2f8a3dd Mention italic styling in docs 2021-09-06 17:02:53 +02:00
Rithvik Vibhu
187214e39e
 		Remove AUR links for tealdeer and tealdeer-bin (#196) 
The package is now in the community repos.
 2021-07-19 13:57:16 +02:00
Cameron Tod
25f736564d
 		Docs: Fix packet/package typo (#185) 2021-05-13 00:25:41 +02:00
Danilo Bargen
978debe6ae Implement new --show-dirs command 
The command prints out the different directories (config, cache, etc)
used by tealdeer.
 2021-01-30 21:32:39 +01:00
Danilo Bargen
931a5fc13c Docs: Document location of cache directory 2020-11-15 00:00:15 +01:00
Danilo Bargen
c33c146a17 Docs: Add README 2020-11-14 23:55:49 +01:00
Danilo Bargen
dff8da40a5 Docs: Add screenshot to intro page 2020-11-01 01:52:01 +01:00
Danilo Bargen
ddeb81b249 Add mdbook documentation 2020-11-01 01:39:47 +01:00