docs: add guide for using Rspress with Rslib#1471
Merged
Conversation
Add documentation for integrating Rspress with Rslib projects to build component library documentation with live previews and API docs. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Deploying rslib with
|
| Latest commit: |
6515e41
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://d47247e2.rslib.pages.dev |
| Branch Preview URL: | https://syt-fix-template.rslib.pages.dev |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for using Rspress (a Rspack-based static site generator) with Rslib to build component library documentation. The documentation covers installation, configuration, and development workflow for integrating Rspress with Rslib projects.
Changes:
- Added English and Chinese documentation guides for using Rspress with Rslib
- Updated navigation meta.json files to include the new Rspress documentation page
- Added
doc_build/directory to gitignore for Rspress build output
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| website/docs/en/guide/advanced/rspress.mdx | English documentation guide for Rspress integration, covering quick start, manual setup, and development workflow |
| website/docs/zh/guide/advanced/rspress.mdx | Chinese documentation guide for Rspress integration (translation of English version) |
| website/docs/en/guide/advanced/_meta.json | Added "rspress" entry to English advanced guides navigation |
| website/docs/zh/guide/advanced/_meta.json | Added "rspress" entry to Chinese advanced guides navigation |
| packages/create-rslib/template-common/gitignore | Added doc_build/ to ignore Rspress build output directory |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
fi3ework
reviewed
Feb 3, 2026
Timeless0911
reviewed
Feb 3, 2026
Timeless0911
reviewed
Feb 3, 2026
Timeless0911
approved these changes
Feb 3, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
doc_build/to template gitignore for Rspress build outputTest plan
🤖 Generated with Claude Code