Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feature request: support setting the index filename? #259

Open
gao-sun opened this issue Aug 28, 2023 · 1 comment
Open

feature request: support setting the index filename? #259

gao-sun opened this issue Aug 28, 2023 · 1 comment
Labels
feature New feature or request

Comments

@gao-sun
Copy link

gao-sun commented Aug 28, 2023

Thanks for the amazing tool.

In GitHub, README.md files in subfolders can also be automatically displayed without opening the file.

It seems the index filename has been fixed to index.md. Is there any chance to make it configurable?

@ap0llo
Copy link
Owner

ap0llo commented Sep 5, 2023

Great to hear you like mddocs.

Yes, configuring the name would certainly be feasible.
But I have to add that I won't have time to work this in the foreseeable future, but I would accept a PR implementing this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants