We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent a840299 commit f3ae326Copy full SHA for f3ae326
docs/setup/setting-up-navigation.md
@@ -262,16 +262,19 @@ navigation section:
262
``` yaml
263
nav:
264
- Section:
265
- - section/index.md
+ - section/index.md # (1)!
266
- Page 1: section/page-1.md
267
...
268
- Page n: section/page-n.md
269
```
270
271
+1. MkDocs also considers files called `README.md` as [index pages].
272
+
273
[Section index pages support]: https://github.com/squidfunk/mkdocs-material/releases/tag/7.3.0
274
[Section index pages enabled]: ../assets/screenshots/navigation-index-on.png
275
[Section index pages disabled]: ../assets/screenshots/navigation-index-off.png
276
[toc.integrate]: #navigation-integration
277
+ [index pages]: https://www.mkdocs.org/user-guide/writing-your-docs/#index-pages
278
279
### Table of contents
280
0 commit comments