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

doc: write README.md

Browse Source
This commit is contained in:
inkch 2025-01-16 21:24:16 +09:00
commit 2564f6764f
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md Normal file
View File

@ -0,0 +1,22 @@
# My very own custom pages for tealdeer (`tldr` client)
My favorite [tldr](https://tldr.sh/) client [tealdeer](https://github.com/tealdeer-rs/tealdeer)
has the ability to show user defined custom pages.
## 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.
## 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. |
See: [Custom Pages and Patches - Tealdeer User Manual](https://tealdeer-rs.github.io/tealdeer/usage_custom_pages.html).