Skip to content

Commit f3ae326

Browse files
committed
Documentation
1 parent a840299 commit f3ae326

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

docs/setup/setting-up-navigation.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -262,16 +262,19 @@ navigation section:
262262
``` yaml
263263
nav:
264264
- Section:
265-
- section/index.md
265+
- section/index.md # (1)!
266266
- Page 1: section/page-1.md
267267
...
268268
- Page n: section/page-n.md
269269
```
270270

271+
1. MkDocs also considers files called `README.md` as [index pages].
272+
271273
[Section index pages support]: https://github.com/squidfunk/mkdocs-material/releases/tag/7.3.0
272274
[Section index pages enabled]: ../assets/screenshots/navigation-index-on.png
273275
[Section index pages disabled]: ../assets/screenshots/navigation-index-off.png
274276
[toc.integrate]: #navigation-integration
277+
[index pages]: https://www.mkdocs.org/user-guide/writing-your-docs/#index-pages
275278

276279
### Table of contents
277280

0 commit comments

Comments
 (0)