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

docs: rename all index.md to README.md #17

Merged
merged 1 commit into from
Feb 27, 2019
Merged

docs: rename all index.md to README.md #17

merged 1 commit into from
Feb 27, 2019

Conversation

ntnyq
Copy link
Contributor

@ntnyq ntnyq commented Feb 26, 2019

Index.md would cause a 404 error as the editLinks point to an README.md which is not existed.

README.md serves it's duty well for vuepress theme default

Example

Click the Edit this page on GitHub link below.

@meteorlxy
Copy link
Owner

Yes is an known issue of Vuepress vuejs/vuepress#1115.

Thanks!

@ntnyq
Copy link
Contributor Author

ntnyq commented Feb 26, 2019

Thanks!

You are welcome.

I've learned a lot from your project.

tgmti added a commit to tgmti/vssue that referenced this pull request Feb 27, 2019
tgmti added a commit to tgmti/vssue that referenced this pull request Feb 27, 2019
Copy link
Owner

@meteorlxy meteorlxy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In fact, I don't like README.md, becasue index.md => index.html looks more reasonable.

OK let's be compatible with current version of Vuepress first.

@meteorlxy meteorlxy merged commit 511ba2b into meteorlxy:master Feb 27, 2019
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

Successfully merging this pull request may close these issues.

None yet

2 participants