feat: route README.md => index

[ruochuan12]

Summary

feat: route README.md => index

links: vuepress route README.md => index

Related Issue

Checklist

• Tests updated (or not required).
• Documentation updated (or not required).

[CLAassistant]

All committers have signed the CLA.

[netlify]

✅ Deploy Preview for aquamarine-blini-95325f ready!

Name	Link
🔨 Latest commit	e8c61ce
🔍 Latest deploy log	https://app.netlify.com/sites/aquamarine-blini-95325f/deploys/66d43ca1c3779d000853f85e
😎 Deploy Preview	https://deploy-preview-1374--aquamarine-blini-95325f.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 90 (🟢 up 17 from production) Accessibility: 97 (no change from production) Best Practices: 92 (no change from production) SEO: 92 (no change from production) PWA: - View the detailed breakdown and full score reports

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[Timeless0911]

Thank you for your submission! Can you sign CLA to let CI pass?

[Timeless0911]

I think we should document how to handle conflicts with index.md and add an e2e test case to cover this feature.

[Timeless0911]

Hi @ruochuan12 , there are some points to discuss with you about this feature:

1. We do not want to introduce this default behavior to affect the original users since the default route of readme.md is not a standardized behavior and many other frameworks do not do this, like Vitepress and Docusaurus.
2. A more appropriate approach is to enable this behavior through a configuration, which is not a easy work, changes in PR should be far from enough. We need complete tests to ensure that route generation, sidebar generation, link href, etc. work properly in all scenes like all files use index / all files use readme / files use mixed readme&index. And how to deal the conflict of two files should be mainly concerned.

[ruochuan12]

Okay, let's not deal with it for now. I look forward to having such a feature in the future.

[SoonIter]

closed

use index.md is enough for now

It will increase the complexity of the routing, if someone needs this pr, they can open a new issue.