CODEWITHSUNDEEP
pythonmkdocsmkdocs-materialmkdocs-macros
Bastian Venthur
Bastian Venthur

Reputation: 16700

How to generate a table of contents with meta data for a set of pages in mkdocs?

I'm using mkdocs and mkdocs-material. I have a set of pages for which I want to generate a table of contents. Additionally, I want the table of contents to display a subset of the meta data provided by the pages indexed by the TOC. E.g.:

myproject/
|-- docs/
|   |-- index.md <- to be generated
|   |-- page1.md
|   |-- page2.md

While the pages (e.g. page1.md) contain meta data such as

---
Title: Some Title
Author: A. U. Thor
Created: 2025-01-21
Something Else: boo
---

The resulting index.md should contain something like:

| Title                 | Author     | Created    |
|-----------------------|------------|------------|
|[Some Title][page1.md] | A. U. Thor | 2025-01-21 |

Is there an existing plugin that can do this? If not, what would be the simplest approach to solve this?

Upvotes: 0

Views: 30

Answers (0)

Related Questions