# HG changeset patch
# User Goffi <goffi@goffi.org>
# Date 1701778495 -3600
# Node ID 0f1a4ffcd41903e7d2b65b5a7f4552d5048bc3c8
# Parent  121925996ffbd217dc87fa3a12fd329b56fb318f
doc (cli/blog): Document new `--alt-link` option

diff -r 121925996ffb -r 0f1a4ffcd419 doc/libervia-cli/blog.rst
--- a/doc/libervia-cli/blog.rst	Tue Dec 05 13:14:33 2023 +0100
+++ b/doc/libervia-cli/blog.rst	Tue Dec 05 13:14:55 2023 +0100
@@ -23,6 +23,21 @@
 
       Use this option judiciously to avoid unintended overwriting of blog posts.
 
+``--alt-link URL [MEDIA_TYPE]``
+
+   Add an alternative link to a blog post, such as a corresponding HTTP page. The *URL*
+   parameter is mandatory, while *MEDIA_TYPE* is optional. Incorporate ``{service}``,
+   ``{node}``, and ``{item}`` as template values within the URL. These will be replaced
+   with the actual values when the item is published. To use curly braces literally,
+   double them: ``{{`` and ``}}``.
+
+example
+-------
+
+Louise  wants to add a link to her public facing HTML blog in her item::
+
+  $ li blog set --alt-link https://example.org/blog/{node}/{item}
+
 set
 ===