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

feat: route README.md => index #1374

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

ruochuan12
Copy link

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
Copy link

CLAassistant commented Sep 1, 2024

CLA assistant check
All committers have signed the CLA.

Copy link

netlify bot commented Sep 1, 2024

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...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
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
Copy link
Collaborator

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

@Timeless0911
Copy link
Collaborator

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

@Timeless0911
Copy link
Collaborator

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
Copy link
Author

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

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

Successfully merging this pull request may close these issues.

3 participants