{"library":"mkdocs-section-index","title":"MkDocs Section Index Plugin","description":"mkdocs-section-index is an MkDocs plugin that enables sections in your navigation to be clickable, leading to an index page rather than just expanding. This addresses a limitation in standard MkDocs where sections are typically not directly navigable pages. It is currently at version 0.3.11 and frequently releases updates to maintain compatibility with new versions of MkDocs and popular themes like MkDocs Material.","language":"python","status":"active","last_verified":"Sat Apr 11","install":{"commands":["pip install mkdocs-section-index"],"cli":{"name":"mkdocs","version":"mkdocs, version 1.6.1 from /usr/local/lib/python3.11/site-packages/mkdocs (Python 3.11)"}},"imports":[],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"# mkdocs.yml\n\nsite_name: My Project Docs\n\nnav:\n  - Home: index.md\n  - Guides:\n    - guides/index.md  # This page becomes the clickable 'Guides' section index\n    - guides/setup.md\n    - guides/usage.md\n  - API Reference: api/index.md # Another way to define a section index\n\nplugins:\n  - search\n  - section-index\n\n# --- Expected file structure ---\n# ./\n# ├── mkdocs.yml\n# └── docs/\n#     ├── index.md\n#     ├── guides/\n#     │   ├── index.md\n#     │   ├── setup.md\n#     │   └── usage.md\n#     └── api/\n#         └── index.md","lang":"yaml","description":"To use mkdocs-section-index, first install it via pip. Then, enable it in your `mkdocs.yml` file under the `plugins` section. Define your navigation (`nav`) structure such that a markdown file (conventionally `index.md`) is specified as the first child of a section. This `index.md` file will then become the clickable index page for that section in the generated documentation.","tag":null,"tag_description":null,"last_tested":"2026-04-25","results":[{"runtime":"python:3.10-alpine","exit_code":1},{"runtime":"python:3.10-slim","exit_code":1},{"runtime":"python:3.11-alpine","exit_code":1},{"runtime":"python:3.11-slim","exit_code":1},{"runtime":"python:3.12-alpine","exit_code":1},{"runtime":"python:3.12-slim","exit_code":1},{"runtime":"python:3.13-alpine","exit_code":1},{"runtime":"python:3.13-slim","exit_code":1},{"runtime":"python:3.9-alpine","exit_code":1},{"runtime":"python:3.9-slim","exit_code":1}]},"compatibility":null}