ceos/tealdeer
1
0
Fork 0
mirror of https://github.com/tealdeer-rs/tealdeer.git synced 2026-08-24 09:04:19 +02:00
Code Issues Projects Releases Packages Wiki Activity

deploy: 17c08f0261

Browse source
This commit is contained in:
dbrgn 2024-02-15 19:28:12 +00:00
commit 04cce2a9c5
4 changed files with 34 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

22
print.html
View file

@ -266,6 +266,16 @@ OPTIONS:
To view the user documentation, please visit https://dbrgn.github.io/tealdeer/.
</code></pre>
<h1><a class="header" href="#custom-pages-and-patches" id="custom-pages-and-patches">Custom Pages and Patches</a></h1>
<!--
TODO: Uncomment when releasing 1.7.0.
> ⚠️ **Breaking change in version 1.7.0:** The file name extension for custom
> pages and patches was changed:
>
> - `<name>.page` → `<name>.page.md`
> - `<name>.patch` → `<name>.patch.md`
>
> If you have custom pages or patches, you need to rename them.
-->
<p>Tealdeer allows creating new custom pages, overriding existing pages as well as
extending existing pages.</p>
<p>The directory, where these custom pages and patches can be placed, follows OS
@ -277,24 +287,24 @@ file</a>.</p>
<h2><a class="header" href="#custom-pages" id="custom-pages">Custom Pages</a></h2>
<p>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
<code>&lt;command&gt;.page</code> in the custom pages directory. When calling <code>tldr &lt;command&gt;</code>,
<code>&lt;command&gt;.page.md</code> in the custom pages directory. When calling <code>tldr &lt;command&gt;</code>,
your custom page will be shown instead of the upstream version in the cache.</p>
<p>Path:</p>
<pre><code>$CUSTOM_PAGES_DIR/&lt;command&gt;.page
<pre><code>$CUSTOM_PAGES_DIR/&lt;command&gt;.page.md
</code></pre>
<p>Example:</p>
<pre><code>~/.local/share/tealdeer/pages/ufw.page
<pre><code>~/.local/share/tealdeer/pages/ufw.page.md
</code></pre>
<h2><a class="header" href="#custom-patches" id="custom-patches">Custom Patches</a></h2>
<p>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 <code>&lt;command&gt;.patch</code>, it will be appended to existing
case, use a file called <code>&lt;command&gt;.patch.md</code>, it will be appended to existing
pages.</p>
<p>Path:</p>
<pre><code>$CUSTOM_PAGES_DIR/&lt;command&gt;.patch
<pre><code>$CUSTOM_PAGES_DIR/&lt;command&gt;.patch.md
</code></pre>
<p>Example:</p>
<pre><code>~/.local/share/tealdeer/pages/ufw.patch
<pre><code>~/.local/share/tealdeer/pages/ufw.patch.md
</code></pre>
<h1><a class="header" href="#configuration" id="configuration">Configuration</a></h1>
<p>Tealdeer can be customized with a config file in <a href="https://toml.io/">TOML

2
searchindex.js
View file

File diff suppressed because one or more lines are too long

2
searchindex.json
View file

File diff suppressed because one or more lines are too long

22
usage_custom_pages.html
View file

@ -164,6 +164,16 @@
<div id="content" class="content">
<main>
<h1><a class="header" href="#custom-pages-and-patches" id="custom-pages-and-patches">Custom Pages and Patches</a></h1>
<!--
TODO: Uncomment when releasing 1.7.0.
> ⚠️ **Breaking change in version 1.7.0:** The file name extension for custom
> pages and patches was changed:
>
> - `<name>.page` → `<name>.page.md`
> - `<name>.patch` → `<name>.patch.md`
>
> If you have custom pages or patches, you need to rename them.
-->
<p>Tealdeer allows creating new custom pages, overriding existing pages as well as
extending existing pages.</p>
<p>The directory, where these custom pages and patches can be placed, follows OS
@ -175,24 +185,24 @@ file</a>.</p>
<h2><a class="header" href="#custom-pages" id="custom-pages">Custom Pages</a></h2>
<p>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
<code>&lt;command&gt;.page</code> in the custom pages directory. When calling <code>tldr &lt;command&gt;</code>,
<code>&lt;command&gt;.page.md</code> in the custom pages directory. When calling <code>tldr &lt;command&gt;</code>,
your custom page will be shown instead of the upstream version in the cache.</p>
<p>Path:</p>
<pre><code>$CUSTOM_PAGES_DIR/&lt;command&gt;.page
<pre><code>$CUSTOM_PAGES_DIR/&lt;command&gt;.page.md
</code></pre>
<p>Example:</p>
<pre><code>~/.local/share/tealdeer/pages/ufw.page
<pre><code>~/.local/share/tealdeer/pages/ufw.page.md
</code></pre>
<h2><a class="header" href="#custom-patches" id="custom-patches">Custom Patches</a></h2>
<p>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 <code>&lt;command&gt;.patch</code>, it will be appended to existing
case, use a file called <code>&lt;command&gt;.patch.md</code>, it will be appended to existing
pages.</p>
<p>Path:</p>
<pre><code>$CUSTOM_PAGES_DIR/&lt;command&gt;.patch
<pre><code>$CUSTOM_PAGES_DIR/&lt;command&gt;.patch.md
</code></pre>
<p>Example:</p>
<pre><code>~/.local/share/tealdeer/pages/ufw.patch
<pre><code>~/.local/share/tealdeer/pages/ufw.patch.md
</code></pre>
</main>