From fe9c7c2bed320fbdb32fe4b44f624cf517607820 Mon Sep 17 00:00:00 2001 From: Xavie Date: Mon, 8 Jun 2026 19:57:28 +0300 Subject: [PATCH] Add note about required blank lines around YFM block constructions --- en/_includes/blank-lines-note.md | 5 +++++ en/syntax/cuts-tabs.md | 2 ++ en/syntax/notes.md | 2 ++ ru/_includes/blank-lines-note.md | 5 +++++ ru/syntax/interactive-elements/accordion.md | 2 ++ ru/syntax/interactive-elements/cuts.md | 2 ++ ru/syntax/interactive-elements/dropdown.md | 2 ++ ru/syntax/interactive-elements/index.md | 4 +++- ru/syntax/interactive-elements/tabs.md | 2 ++ ru/syntax/notes.md | 2 ++ 10 files changed, 27 insertions(+), 1 deletion(-) create mode 100644 en/_includes/blank-lines-note.md create mode 100644 ru/_includes/blank-lines-note.md diff --git a/en/_includes/blank-lines-note.md b/en/_includes/blank-lines-note.md new file mode 100644 index 00000000..94f07b5a --- /dev/null +++ b/en/_includes/blank-lines-note.md @@ -0,0 +1,5 @@ +{% note warning %} + +A construction works only when it is separated by empty lines — outside (before the opening tag and after the closing one) and inside (between the tags and the content). Otherwise it won't render and will stay as plain text. + +{% endnote %} diff --git a/en/syntax/cuts-tabs.md b/en/syntax/cuts-tabs.md index 4c3bd9bd..6288c85a 100644 --- a/en/syntax/cuts-tabs.md +++ b/en/syntax/cuts-tabs.md @@ -8,6 +8,8 @@ The content of cuts and tabs can include any YFM markup. {% endnote %} +{% include [blank-lines](../_includes/blank-lines-note.md) %} + ## Cuts {#cuts} Use cuts to hide content. For example, additional information or long blocks of code. diff --git a/en/syntax/notes.md b/en/syntax/notes.md index 76d2cff8..23c09b62 100644 --- a/en/syntax/notes.md +++ b/en/syntax/notes.md @@ -12,6 +12,8 @@ Depending on the content, notes with different titles and formatting are used: Notes can include any YFM markup, but we don't recommend overloading them with elements. Choose a simple design and don't overuse notes because this will distract the user from the main content. +{% include [blank-lines](../_includes/blank-lines-note.md) %} + ## Comment ```markdown diff --git a/ru/_includes/blank-lines-note.md b/ru/_includes/blank-lines-note.md new file mode 100644 index 00000000..af37d738 --- /dev/null +++ b/ru/_includes/blank-lines-note.md @@ -0,0 +1,5 @@ +{% note warning %} + +Конструкция работает, только если отделена пустыми строками — снаружи (до открывающего и после закрывающего тега) и внутри (между тегами и содержимым). Иначе она не обработается и останется обычным текстом. + +{% endnote %} diff --git a/ru/syntax/interactive-elements/accordion.md b/ru/syntax/interactive-elements/accordion.md index 25130d0a..734b24a3 100644 --- a/ru/syntax/interactive-elements/accordion.md +++ b/ru/syntax/interactive-elements/accordion.md @@ -2,6 +2,8 @@ Аккордеон позволяет свернуть или раскрыть содержимое по вашему выбору, подходит для организации больших объемов информации. +{% include [blank-lines](../../_includes/blank-lines-note.md) %} + ```markdown {% list tabs accordion %} diff --git a/ru/syntax/interactive-elements/cuts.md b/ru/syntax/interactive-elements/cuts.md index e9938fbc..f54b0db7 100644 --- a/ru/syntax/interactive-elements/cuts.md +++ b/ru/syntax/interactive-elements/cuts.md @@ -2,6 +2,8 @@ Используйте каты, чтобы скрыть часть контента. Например, дополнительную информацию или длинные блоки кода. +{% include [blank-lines](../../_includes/blank-lines-note.md) %} + ```markdown {% cut "Заголовок ката" %} diff --git a/ru/syntax/interactive-elements/dropdown.md b/ru/syntax/interactive-elements/dropdown.md index 2751bd0e..a647befb 100644 --- a/ru/syntax/interactive-elements/dropdown.md +++ b/ru/syntax/interactive-elements/dropdown.md @@ -2,6 +2,8 @@ Дропдаун — выпадающий список. Используйте его для группировки элементов со скрытым контентом. +{% include [blank-lines](../../_includes/blank-lines-note.md) %} + ```markdown {% list tabs dropdown %} diff --git a/ru/syntax/interactive-elements/index.md b/ru/syntax/interactive-elements/index.md index 55e2f557..b02559fd 100644 --- a/ru/syntax/interactive-elements/index.md +++ b/ru/syntax/interactive-elements/index.md @@ -12,4 +12,6 @@ Содержимое интерактивных элементов разметки может включать любую разметку YFM. -{% endnote %} \ No newline at end of file +{% endnote %} + +{% include [blank-lines](../../_includes/blank-lines-note.md) %} \ No newline at end of file diff --git a/ru/syntax/interactive-elements/tabs.md b/ru/syntax/interactive-elements/tabs.md index 6f7f7016..c30de2b6 100644 --- a/ru/syntax/interactive-elements/tabs.md +++ b/ru/syntax/interactive-elements/tabs.md @@ -2,6 +2,8 @@ Используйте табы для взаимоисключающих разделов. Например, чтобы разделить инструкции для разных ОС. +{% include [blank-lines](../../_includes/blank-lines-note.md) %} + ```markdown {% list tabs %} diff --git a/ru/syntax/notes.md b/ru/syntax/notes.md index cdbd60b2..d8ecad18 100644 --- a/ru/syntax/notes.md +++ b/ru/syntax/notes.md @@ -11,6 +11,8 @@ Заметки могут включать любую разметку YFM, но не рекомендуется перегружать их элементами. Выбирайте простое оформление и не используйте заметки слишком часто, так как это будет отвлекать пользователя от основного содержимого. +{% include [blank-lines](../_includes/blank-lines-note.md) %} + ## Примечание {#info} ```markdown