oprypin / mkdocs-section-index

MkDocs plugin to allow clickable sections that lead to an index page
https://oprypin.github.io/mkdocs-section-index
MIT License
77 stars 8 forks source link

Use markdown heading options #17

Open Archmonger opened 1 year ago

Archmonger commented 1 year ago

Currently this plugin assumes that any section without a nav title is a section index. This is an implicit assumption, and a fairly annoying one sometimes.

It would be better to be explicit by also requiring that the section index has a markdown heading property. It could look like this:

---
section_index: true
---

# Hello World!

This is some random text!