-
Notifications
You must be signed in to change notification settings - Fork 120
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #237 from dbrgn/improved-docs
- Loading branch information
Showing
7 changed files
with
91 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# Section: \[directories\] | ||
|
||
This section allows overriding some directory paths. | ||
|
||
## `custom_pages_dir` | ||
|
||
Set the directory to be used to look up [custom | ||
pages](usage_custom_pages.html). Remember to use an absolute path. Variable | ||
expansion will not be performed on the path. | ||
|
||
[directories] | ||
custom_pages_dir = "/home/myuser/custom-tldr-pages/" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# display | ||
# Section: \[display\] | ||
|
||
In the `display` section you can configure the output format. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# style | ||
# Section: \[style\] | ||
|
||
Using the config file, the style (e.g. colors or underlines) can be customized. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# updates | ||
# Section: \[updates\] | ||
|
||
## Automatic updates | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# Custom Pages and Patches | ||
|
||
Tealdeer allows creating new custom pages, overriding existing pages as well as | ||
extending existing pages. | ||
|
||
The directory, where these custom pages and patches can be placed, follows OS | ||
conventions. On Linux, for example, the default location is | ||
`~/.local/share/tealdeer/pages/`. To print the path used on your system, simply | ||
run `tldr --show-paths`. | ||
|
||
The custom pages directory can be [overridden by the config | ||
file](config_directories.html). | ||
|
||
## Custom Pages | ||
|
||
To document internal command line tools, or if you want to replace an existing | ||
tldr page with one that's better suited for you, place a file with the name | ||
`<command>.page` in the custom pages directory. When calling `tldr <command>`, | ||
your custom page will be shown instead of the upstream version in the cache. | ||
|
||
Path: | ||
|
||
$CUSTOM_PAGES_DIR/<command>.page | ||
|
||
Example: | ||
|
||
~/.local/share/tealdeer/pages/ufw.page | ||
|
||
## Custom Patches | ||
|
||
Sometimes you don't want to fully replace an existing upstream page, but just | ||
want to extend it with your own examples that you frequently need. In this | ||
case, use a file called `<command>.patch`, it will be appended to existing | ||
pages. | ||
|
||
Path: | ||
|
||
$CUSTOM_PAGES_DIR/<command>.patch | ||
|
||
Example: | ||
|
||
~/.local/share/tealdeer/pages/ufw.patch |