Skip to content

Document the required blank lines around YFM block constructions#291

Merged
bloodmike merged 1 commit into
diplodoc-platform:masterfrom
X4vi3:blank-lines-requirement
Jun 9, 2026
Merged

Document the required blank lines around YFM block constructions#291
bloodmike merged 1 commit into
diplodoc-platform:masterfrom
X4vi3:blank-lines-requirement

Conversation

@X4vi3

@X4vi3 X4vi3 commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

What changed

Pages documenting YFM block constructions ({% note %}, {% cut %}, {% list tabs %}, accordion, dropdown) didn't mention that the construction must be surrounded by blank lines — otherwise it isn't parsed and renders as plain text.

Added a short warning note about this requirement to all relevant pages.

How

  • Added a shared include with the warning text (single source of truth), following the existing _includes/common-params-note.md pattern:
    • ru/_includes/blank-lines-note.md
    • en/_includes/blank-lines-note.md
  • Included it right after the intro paragraph (before the first example) on the relevant pages:
    • RU: notes.md, interactive-elements/{cuts,tabs,accordion,dropdown,index}.md
    • EN: notes.md, cuts-tabs.md

Notes

  • interactive-elements/radio.md was left as is — it already has a more detailed warning about blank lines and indentation.

@github-actions

github-actions Bot commented Jun 8, 2026

Copy link
Copy Markdown

✅ Documentation build

Revision built successfully
Revision preview link

@bloodmike bloodmike merged commit fc4b5dc into diplodoc-platform:master Jun 9, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants