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: use meta.json to generate nav and sidebar configs #6345

Merged
merged 10 commits into from
Apr 24, 2024

Conversation

chenjiahan
Copy link
Member

Summary

Use meta.json to generate nav and sidebar configs, see: https://rspress.dev/guide/basic/auto-nav-sidebar

Benefits:

  • Automatically generate sidebar configuration, no need to configure rspress.config.ts.
  • Automatically read the h1 of the document as label
  • Allow Chinese and English documents to configure different navigation configs

Note that some URLs has changed due to this change.

Checklist

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

@chenjiahan chenjiahan requested a review from SyMind April 24, 2024 06:18
@github-actions github-actions bot added the team The issue/pr is created by the member of Rspack. label Apr 24, 2024
Copy link

netlify bot commented Apr 24, 2024

Deploy Preview for rspack ready!

Name Link
🔨 Latest commit c3ab9dd
🔍 Latest deploy log https://app.netlify.com/sites/rspack/deploys/6628a44e491e7c0008ff2912
😎 Deploy Preview https://deploy-preview-6345--rspack.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@chenjiahan chenjiahan merged commit bb7b1c2 into main Apr 24, 2024
34 checks passed
@chenjiahan chenjiahan deleted the website_auto_sidebar_0424 branch April 24, 2024 06:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
team The issue/pr is created by the member of Rspack.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants