From d9f6613164b9e1be2f7572581639af0169ead919 Mon Sep 17 00:00:00 2001 From: "Kyle J. McKay" Date: Sat, 5 Jun 2021 22:31:36 -0700 Subject: [PATCH] syntax.md: mention headers supersede horizontal rules Add a note to the syntax document mentioning that when using a line of solid hyphens (`-`s) for a horizontal rule, it will actually be treated as an H2 Setext-style header if the preceding line is not blank. Signed-off-by: Kyle J. McKay --- syntax.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/syntax.md b/syntax.md index 74d537c..81bf20f 100644 --- a/syntax.md +++ b/syntax.md @@ -817,6 +817,12 @@ following lines will produce a horizontal rule: --------------------------------------- +Note that when using a line of three or more solid hyphens, if the +preceding line is not empty, then it will be treated as part of one of +the H2 Setext-style [headers]. Add at least one space between the +hyphens to prevent that (or use asterisks or make sure the preceding +line is blank). + - - - - -