From b967d0184dfdc946c4c73577a94f32d4caf04d82 Mon Sep 17 00:00:00 2001 From: Dan Date: Tue, 13 Aug 2019 15:08:16 +0200 Subject: [PATCH] Docs: Clarify supported header style Only atx-style headers are supported for page titles, not Setext styles. Fixes #1837 --- docs/user-guide/writing-your-docs.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/user-guide/writing-your-docs.md b/docs/user-guide/writing-your-docs.md index d4f047d3..665fdd99 100644 --- a/docs/user-guide/writing-your-docs.md +++ b/docs/user-guide/writing-your-docs.md @@ -365,11 +365,14 @@ specific page. The following keys are supported: 1. A title defined in the [nav] configuration setting for a document. 2. A title defined in the `title` meta-data key of a document. 3. A level 1 Markdown header on the first line of the document body. + Please note that [Setext-style] headers are not supported. 4. The filename of a document. Upon finding a title for a page, MkDoc does not continue checking any additional sources in the above list. +[Setext-style]: https://daringfireball.net/projects/markdown/syntax#header + #### YAML Style Meta-Data YAML style meta-data consists of [YAML] key/value pairs wrapped in YAML style