centersl/mkdocs
1
0
Fork 0
mirror of https://github.com/mkdocs/mkdocs.git synced 2026-03-27 09:58:31 +07:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Clarify supported header style

Browse Source 
Only atx-style headers are supported for page titles,
not Setext styles.

Fixes #1837
This commit is contained in:
Dan
2019-08-13 15:08:16 +02:00
committed by Waylan Limberg
parent a84b5a27df
commit b967d0184d
1 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/user-guide/writing-your-docs.md
View File

@@ -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