From 2564f6764f42df9895ebec7746d223db19d88e03 Mon Sep 17 00:00:00 2001 From: inkch Date: Thu, 16 Jan 2025 21:24:16 +0900 Subject: [PATCH] doc: write README.md --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..39b6fa6 --- /dev/null +++ b/README.md @@ -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 | `.page.md` | shown instead of the upstream version in the cache. | +| Custom Patch | `.patch.md` | appended to existing pages. | + + +See: [Custom Pages and Patches - Tealdeer User Manual](https://tealdeer-rs.github.io/tealdeer/usage_custom_pages.html).