51369b610e
When an include is not surrounded by empty lines, its content is inlined on the same line as the adjacent content. That can lead to broken tags and other display issues. This PR fixes all such includes and introduces a validation step that forbids introducing the same problem again.
25 lines
556 B
Plaintext
25 lines
556 B
Plaintext
= AsciiDoc Dos & Don'ts
|
|
|
|
=== Include
|
|
|
|
Make sure that `include` statements are surrounded by blank lines.
|
|
AsciiDoc will sometimes (depending on the version) trim whitespaces at the beginning and end of the included files. Any adjacent text will thus be stuck to the inlined content, which could lead to display issues like swallowed title tags.
|
|
|
|
==== Write
|
|
|
|
----
|
|
== Title
|
|
|
|
include::how-to-fix-it/core.adoc[]
|
|
|
|
include::how-to-fix-it/symfony.adoc[]
|
|
----
|
|
|
|
==== Avoid
|
|
|
|
----
|
|
== Title
|
|
include::how-to-fix-it/core.adoc[]
|
|
include::how-to-fix-it/symfony.adoc[]
|
|
----
|