search

shuding / nextra-theme-docs

A documentation site theme for Nextra.
https://github.com/shuding/nextra
MIT License
21 stars 8 forks source link

treat README.md as index.md #2

Open Kikobeats opened 4 years ago

Kikobeats commented 4 years ago

I'm trying to setup nextra for a GitHub documentation and I have to convert all the README.md files to be index.md

Since README.md is the standard filename used by GitHub to be used as index.md in nextra world, why not do that automatically?

shuding commented 4 years ago

Yeah that's a good idea, currently it's kinda restricted by Next.js' file-system routing and I don't see an easy way to bypass that. Will keep this issue open for now, thanks!