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

[REQ][MARKDOWN] Option to rename the README.md file #19940

Open
traed opened this issue Oct 22, 2024 · 0 comments
Open

[REQ][MARKDOWN] Option to rename the README.md file #19940

traed opened this issue Oct 22, 2024 · 0 comments

Comments

@traed
Copy link

traed commented Oct 22, 2024

Is your feature request related to a problem? Please describe.

Currently the main file output but the markdown generator is called README.md. If we want to host the docs as a github wiki the main file needs to be called Home.md. Therefore we need the option to provide a custom name for the main file.

Describe alternatives you've considered

We could just rename the file after generation but then we'd also have to search and replace the word README across all files to fix broken links.

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

No branches or pull requests

1 participant