Skip to content

Commit fc4b5dc

Browse files
authored
Merge pull request #291 from X4vi3/blank-lines-requirement
Document the required blank lines around YFM block constructions
2 parents c28b81d + fe9c7c2 commit fc4b5dc

10 files changed

Lines changed: 27 additions & 1 deletion

File tree

en/_includes/blank-lines-note.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{% note warning %}
2+
3+
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.
4+
5+
{% endnote %}

en/syntax/cuts-tabs.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ The content of cuts and tabs can include any YFM markup.
88

99
{% endnote %}
1010

11+
{% include [blank-lines](../_includes/blank-lines-note.md) %}
12+
1113
## Cuts {#cuts}
1214

1315
Use cuts to hide content. For example, additional information or long blocks of code.

en/syntax/notes.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ Depending on the content, notes with different titles and formatting are used:
1212

1313
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.
1414

15+
{% include [blank-lines](../_includes/blank-lines-note.md) %}
16+
1517
## Comment
1618

1719
```markdown

ru/_includes/blank-lines-note.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{% note warning %}
2+
3+
Конструкция работает, только если отделена пустыми строками — снаружи (до открывающего и после закрывающего тега) и внутри (между тегами и содержимым). Иначе она не обработается и останется обычным текстом.
4+
5+
{% endnote %}

ru/syntax/interactive-elements/accordion.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Аккордеон позволяет свернуть или раскрыть содержимое по вашему выбору, подходит для организации больших объемов информации.
44

5+
{% include [blank-lines](../../_includes/blank-lines-note.md) %}
6+
57
```markdown
68
{% list tabs accordion %}
79

ru/syntax/interactive-elements/cuts.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Используйте каты, чтобы скрыть часть контента. Например, дополнительную информацию или длинные блоки кода.
44

5+
{% include [blank-lines](../../_includes/blank-lines-note.md) %}
6+
57
```markdown
68
{% cut "Заголовок ката" %}
79

ru/syntax/interactive-elements/dropdown.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Дропдаун — выпадающий список. Используйте его для группировки элементов со скрытым контентом.
44

5+
{% include [blank-lines](../../_includes/blank-lines-note.md) %}
6+
57
```markdown
68
{% list tabs dropdown %}
79

ru/syntax/interactive-elements/index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,6 @@
1212

1313
Содержимое интерактивных элементов разметки может включать любую разметку YFM.
1414

15-
{% endnote %}
15+
{% endnote %}
16+
17+
{% include [blank-lines](../../_includes/blank-lines-note.md) %}

ru/syntax/interactive-elements/tabs.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Используйте табы для взаимоисключающих разделов. Например, чтобы разделить инструкции для разных ОС.
44

5+
{% include [blank-lines](../../_includes/blank-lines-note.md) %}
6+
57
```markdown
68
{% list tabs %}
79

ru/syntax/notes.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111

1212
Заметки могут включать любую разметку YFM, но не рекомендуется перегружать их элементами. Выбирайте простое оформление и не используйте заметки слишком часто, так как это будет отвлекать пользователя от основного содержимого.
1313

14+
{% include [blank-lines](../_includes/blank-lines-note.md) %}
15+
1416
## Примечание {#info}
1517

1618
```markdown

0 commit comments

Comments
 (0)