changeset 4177:0f1a4ffcd419

doc (cli/blog): Document new `--alt-link` option
author Goffi <goffi@goffi.org>
date Tue, 05 Dec 2023 13:14:55 +0100
parents 121925996ffb
children cf0ea77f9537
files doc/libervia-cli/blog.rst
diffstat 1 files changed, 15 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- 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
 ===