docs: enhance HTML generation for source.entry#5337
Merged
chenjiahan merged 2 commits intomainfrom May 31, 2025
Merged
Conversation
✅ Deploy Preview for rsbuild ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the documentation for HTML generation within the Rsbuild configuration, adding detailed explanations and updated code examples for both Chinese and English versions.
- Added a dedicated "HTML 生成" / "HTML generation" section in guide and configuration docs.
- Updated configuration examples and explanatory comments for both single-entry and global HTML generation control.
- Revised inline comments in source config types for improved clarity.
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| website/docs/zh/guide/basic/html-template.mdx | Added section explaining HTML generation and default template usage. |
| website/docs/zh/config/tools/html-plugin.mdx | Revised text to clarify disabling HTML generation for the plugin. |
| website/docs/zh/config/source/entry.mdx | Enhanced explanation and examples for entry configuration and HTML generation control. |
| website/docs/en/guide/basic/html-template.mdx | Added section for HTML generation and detail on the built-in template. |
| website/docs/en/config/source/entry.mdx | Updated instructions and examples regarding disabling HTML generation for entries. |
| packages/core/src/types/config.ts | Improved documentation comments for the source.entry configuration. |
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
Added detailed explanations of how Rsbuild generates HTML files for each entry defined in
source.entry, including the use ofhtml-rspack-pluginand the ability to control HTML generation via thehtmlproperty in the entry description object.Checklist