From 7477220ce0218354e16406fd26912fb1c4c1f901 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?K=C3=A9vin=20Commaille?= Date: Sun, 13 Oct 2024 13:23:31 +0200 Subject: [PATCH] Remove tip about `<>` shortcode delimiters MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit They should not be necessary, and in some cases they break some expectations, like a shortcode that is separated from other text to be in its own paragraph is not actually wrapped by a `p` element, breaking the spacing between paragraphs. Signed-off-by: Kévin Commaille --- meta/documentation_style.rst | 3 --- 1 file changed, 3 deletions(-) diff --git a/meta/documentation_style.rst b/meta/documentation_style.rst index 6ed1b23a..1844f6ec 100644 --- a/meta/documentation_style.rst +++ b/meta/documentation_style.rst @@ -91,9 +91,6 @@ current version is `v1.1` then annotate your changes with `v1.2`. * `{{% added-in v="1.2" %}}` or `{{% changed-in v="1.2" %}}` within Markdown documents. * `x-addedInMatrixVersion` and `x-changedInMatrixVersion` within OpenAPI. -**Tip**: If you're trying to inline the Markdown version and getting unexpected results, -try replacing the `%` symbols with `<` and `>`, changing how Hugo renders the shortcode. - OpenAPI ~~~~~~~