Mercurial > libervia-backend

comparison doc/libervia-cli/blog.rst @ 4177:0f1a4ffcd419

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc (cli/blog): Document new `--alt-link` option
author Goffi <goffi@goffi.org>
date Tue, 05 Dec 2023 13:14:55 +0100
parents 6929dabf3a7e
children cf0ea77f9537
comparison
equal deleted inserted replaced
4176:121925996ffb 4177:0f1a4ffcd419
20 This option removes the randomly generated suffix from the auto-generated, user-friendly ID. The suffix is initially added to ensure unique IDs, especially useful when two posts have similar titles. Use this option with caution, as it may lead to ID conflicts and potential overwriting of existing posts. 20 This option removes the randomly generated suffix from the auto-generated, user-friendly ID. The suffix is initially added to ensure unique IDs, especially useful when two posts have similar titles. Use this option with caution, as it may lead to ID conflicts and potential overwriting of existing posts.
21 21
22 .. warning:: 22 .. warning::
23 23
24 Use this option judiciously to avoid unintended overwriting of blog posts. 24 Use this option judiciously to avoid unintended overwriting of blog posts.
25
26 ``--alt-link URL [MEDIA_TYPE]``
27
28 Add an alternative link to a blog post, such as a corresponding HTTP page. The *URL*
29 parameter is mandatory, while *MEDIA_TYPE* is optional. Incorporate ``{service}``,
30 ``{node}``, and ``{item}`` as template values within the URL. These will be replaced
31 with the actual values when the item is published. To use curly braces literally,
32 double them: ``{{`` and ``}}``.
33
34 example
35 -------
36
37 Louise wants to add a link to her public facing HTML blog in her item::
38
39 $ li blog set --alt-link https://example.org/blog/{node}/{item}
25 40
26 set 41 set
27 === 42 ===
28 43
29 publish a blog item. 44 publish a blog item.