summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDan Allen <dan.j.allen@gmail.com>2022-07-13 23:56:50 -0600
committerDan Allen <dan.j.allen@gmail.com>2022-07-14 01:15:25 -0600
commit0ef5539c78e4c27722df1b8cf5b80831cf915cda (patch)
tree10a478cb7eb5f2ce552e4951b8dc24c4a37dc465
parent9816f47035bbf789eba7edd3bb047278c43b2d02 (diff)
document how to turn off compat mode when using the setext-style document title
-rw-r--r--docs/modules/migrate/pages/asciidoc-py.adoc11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/modules/migrate/pages/asciidoc-py.adoc b/docs/modules/migrate/pages/asciidoc-py.adoc
index edc15f7c..a7a99906 100644
--- a/docs/modules/migrate/pages/asciidoc-py.adoc
+++ b/docs/modules/migrate/pages/asciidoc-py.adoc
@@ -316,6 +316,17 @@ Compat Mode
\ifdef::compat-mode[Compat mode is on!]
----
+If you prefer the setext-style document title, but don't want compat mode to be enabled, you must unset the `compat-mode` attribute explicitly.
+
+[,asciidoc]
+----
+Not Compat Mode
+===============
+:!compat-mode:
+
+\ifndef::compat-mode[Compat mode is not on.]
+----
+
When compat mode is enabled, Asciidoctor adapts some of its behavior and its interpretation of AsciiDoc to more closely align with AsciiDoc.py.
The most noticeable difference is that backticks now only indicate monospace text as opposed to literal monospace.
Literal monospace is signified using a compound markup that combines an inline passthrough with monospace formatting.