tealdeer-custom-pages/README.md

Custom pages for tealdeer

My favorite tldr client 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.

File name extension

There are two types of files for defining custom 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.