rspec/docs/asciidoc_dos_and_donts.adoc

25 lines
556 B
Plaintext
Raw Permalink Normal View History

2023-02-28 11:34:49 +01:00
= 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.
2023-02-28 11:34:49 +01:00
==== Write
----
== Title
2023-02-28 11:34:49 +01:00
include::how-to-fix-it/core.adoc[]
include::how-to-fix-it/symfony.adoc[]
----
==== Avoid
----
== Title
2023-02-28 11:34:49 +01:00
include::how-to-fix-it/core.adoc[]
include::how-to-fix-it/symfony.adoc[]
----