From f3ae326e1a620e6ef84f37d41f5bf653f677f1a7 Mon Sep 17 00:00:00 2001 From: squidfunk Date: Sun, 26 Feb 2023 11:49:11 +0100 Subject: [PATCH] Documentation --- docs/setup/setting-up-navigation.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/setup/setting-up-navigation.md b/docs/setup/setting-up-navigation.md index ed81f698e..ea8684256 100644 --- a/docs/setup/setting-up-navigation.md +++ b/docs/setup/setting-up-navigation.md @@ -262,16 +262,19 @@ navigation section: ``` yaml nav: - Section: - - section/index.md + - section/index.md # (1)! - Page 1: section/page-1.md ... - Page n: section/page-n.md ``` +1. MkDocs also considers files called `README.md` as [index pages]. + [Section index pages support]: https://github.com/squidfunk/mkdocs-material/releases/tag/7.3.0 [Section index pages enabled]: ../assets/screenshots/navigation-index-on.png [Section index pages disabled]: ../assets/screenshots/navigation-index-off.png [toc.integrate]: #navigation-integration + [index pages]: https://www.mkdocs.org/user-guide/writing-your-docs/#index-pages ### Table of contents