Skip to content

Allow both index.md for VuePress root and README.md for Git info #944

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

Closed
benhaynes opened this issue Oct 19, 2018 · 1 comment
Closed

Allow both index.md for VuePress root and README.md for Git info #944

benhaynes opened this issue Oct 19, 2018 · 1 comment

Comments

@benhaynes
Copy link

Feature request

What problem does this feature solve?

Allows for a VuePress index page (/index.md -> /index.html) in addition to the common /README.md for the repository's info file. This would allow you to have a custom/informational README file displayed on git services such as GitHub instead of the VuePress homepage with YAML front-matter.

What does the proposed API look like?

I don't know if the API would change based on this feature.

How should this be implemented in your opinion?

The /index.md should take priority over the /README.md in the root when generating the /index.html file (the opposite is true now, with README taking priority). If this is too much of a breaking change, then an option or flag could be added to the VuePress config.js to manually set the default index file to build.

Are you willing to work on this yourself?**

I am willing to offer my time, but wouldn't know how to implement the change itself.

@ulivz
Copy link
Member

ulivz commented Oct 20, 2018

This feature has been supported by #23

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

No branches or pull requests

2 participants