# matching-index-files

Straightforward Vuepress plugin that accepts a Markdown file as an index file if its name matches the directory's name.

In other words, if you have some route like /about, you can write your page in docs/about/about.md instead of docs/about/README.md.

This might make searching through your Markdown files a little easier, and can also be useful if you want to have README's for another purpose.

Matching index files will supersede any README.md or index.md in the same directory. If this occurs, Vuepress' build logs should notify you with something like: warning Override existing page <AFFECTED_ROUTE_HERE>

# Installation

This isn't on npm yet. For now, clone the repo and install locally.

# Options

debug Boolean:
Logs the resulting additionalPages value.

Made with ❤️ by Ahmad Mostafa - @z3by