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 page title generation

Browse Source
This commit is contained in:
Dan Untenzu
2019-08-13 09:04:02 +02:00
committed by Waylan Limberg
parent b967d0184d
commit 625e423b76
2 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/user-guide/configuration.md
View File

@@ -182,7 +182,8 @@ including how to create sub-sections.
Navigation items may also include links to external sites. While titles are
optional for internal links, they are required for external links. An external
link may be a full URL or a relative URL. Any path which is not found in the
files is assumed to be an external link.
files is assumed to be an external link. See the section about [Meta-Data] on
how MkDocs determines the page title of a document.
```yaml
nav:
@@ -217,7 +218,7 @@ server root and effectively points to `https://example.com/bugs/`. Of course, th
**default**: By default `nav` will contain an alphanumerically sorted, nested
list of all the Markdown files found within the `docs_dir` and its
sub-directories. If none are found it will be `[]` (an empty list).
sub-directories. Index files will always be listed first within a sub-section.
## Build directories

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

@@ -111,9 +111,9 @@ source files for the above configuration would be located at `docs/index.md` and
`docs/about.md`.
The above example will result in two navigation items being created at the top
level and with their titles inferred from the contents of the file (or the
filename if no title is defined within the file). To define a custom title for
the pages, the title can be added before the filename.
level and with their titles inferred from the contents of the Markdown file or,
if no title is defined within the file, of the file name. To override the title
in the `nav` setting add a title right before the filename.
```no-highlight
nav: