inkch/tealdeer-custom-pages
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: change title & <name> to <command> as official doc

Browse Source
This commit is contained in:
inkch 2025-01-16 21:29:55 +09:00
parent 1aeb190252
commit 449c8e8b4a
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -1,22 +1,23 @@
# My very own custom pages for tealdeer (`tldr` client)
# Custom pages for tealdeer
My favorite [tldr](https://tldr.sh/) client [tealdeer](https://github.com/tealdeer-rs/tealdeer)
has the ability to show user defined custom pages.
This repository contains my very own custom pages for `tealdeer`.
## How to use
Clone this repo to the parent directory of `Custom pages dir` (default: `~/.local/share/tealdeer`).
To print the path used on your system, simply run tldr --show-paths.
To print the path used on your system, simply run `tldr --show-paths`.
## File name extension
There are two types of files for defining custom pages:
| Type | Extension | Description |
|---------------|-------------------|-----------------------------------------------------|
| Custom Page | `<name>.page.md` | shown instead of the upstream version in the cache. |
| Custom Patch | `<name>.patch.md` | appended to existing pages. |
| Type | Extension | Description |
|---------------|----------------------|-----------------------------------------------------|
| Custom Page | `<command>.page.md` | shown instead of the upstream version in the cache. |
| Custom Patch | `<command>.patch.md` | appended to existing pages. |
See: [Custom Pages and Patches - Tealdeer User Manual](https://tealdeer-rs.github.io/tealdeer/usage_custom_pages.html).