From 5950e4481a3890abeb840309705941b6abe88914 Mon Sep 17 00:00:00 2001 From: David Anson Date: Mon, 23 Oct 2023 20:37:38 -0700 Subject: [PATCH] Update documentation for MD023/heading-start-left to include "indented" example within block quote (fixes #1009). --- doc-build/md023.md | 7 +++++++ doc/Rules.md | 7 +++++++ doc/md023.md | 7 +++++++ 3 files changed, 21 insertions(+) diff --git a/doc-build/md023.md b/doc-build/md023.md index 57d549e8..9a5a3556 100644 --- a/doc-build/md023.md +++ b/doc-build/md023.md @@ -14,5 +14,12 @@ Some text # Heading ``` +Note that scenarios like block quotes "indent" the start of the line, so the +following is also correct: + +```markdown +> # Heading in Block Quote +``` + Rationale: Headings that don't start at the beginning of the line will not be parsed as headings, and will instead appear as regular text. diff --git a/doc/Rules.md b/doc/Rules.md index 2c5dfceb..1a62a2b8 100644 --- a/doc/Rules.md +++ b/doc/Rules.md @@ -875,6 +875,13 @@ Some text # Heading ``` +Note that scenarios like block quotes "indent" the start of the line, so the +following is also correct: + +```markdown +> # Heading in Block Quote +``` + Rationale: Headings that don't start at the beginning of the line will not be parsed as headings, and will instead appear as regular text. diff --git a/doc/md023.md b/doc/md023.md index 6ff3a7fd..458295c3 100644 --- a/doc/md023.md +++ b/doc/md023.md @@ -22,5 +22,12 @@ Some text # Heading ``` +Note that scenarios like block quotes "indent" the start of the line, so the +following is also correct: + +```markdown +> # Heading in Block Quote +``` + Rationale: Headings that don't start at the beginning of the line will not be parsed as headings, and will instead appear as regular text.