Skip to content

docs(ESM): add ESM guide#11344

Merged
chenjiahan merged 10 commits into
mainfrom
esm-doc
Aug 21, 2025
Merged

docs(ESM): add ESM guide#11344
chenjiahan merged 10 commits into
mainfrom
esm-doc

Conversation

@fi3ework
Copy link
Copy Markdown
Member

@fi3ework fi3ework commented Aug 8, 2025

Summary

add ESM guide, @JSerFeng please take a look at the roadmap section, i'll update English version after your revision.

Related links

Checklist

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

@github-actions github-actions Bot added the release: document release: document related release(mr only) label Aug 8, 2025
@netlify
Copy link
Copy Markdown

netlify Bot commented Aug 8, 2025

Deploy Preview for rspack ready!

Name Link
🔨 Latest commit 87bba51
🔍 Latest deploy log https://app.netlify.com/projects/rspack/deploys/68a6cc1cf79b3b0008d25cd8
😎 Deploy Preview https://deploy-preview-11344--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 project configuration.

@github-actions github-actions Bot added the team The issue/pr is created by the member of Rspack. label Aug 8, 2025
Comment thread website/docs/zh/guide/features/esm.mdx
Comment thread website/docs/zh/guide/features/esm.mdx Outdated
@fi3ework fi3ework force-pushed the esm-doc branch 3 times, most recently from 9b0a109 to c725692 Compare August 19, 2025 03:56
@fi3ework fi3ework marked this pull request as ready for review August 19, 2025 03:58
@fi3ework fi3ework requested review from JSerFeng and Copilot August 19, 2025 03:58
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds comprehensive ESM (ECMAScript Modules) documentation to the Rspack project, providing guides for both Chinese and English versions that explain how to build applications and libraries with ESM output format.

  • Adds detailed ESM configuration documentation with 12 key configuration options and their effects
  • Provides specific examples for building both applications and libraries in ESM format
  • Includes future roadmap and current limitations of ESM support in Rspack

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 6 comments.

File Description
website/docs/zh/guide/features/esm.mdx Adds Chinese ESM guide with configuration options, examples, and roadmap
website/docs/en/guide/features/esm.mdx Adds English ESM guide mirroring the Chinese version
website/docs/zh/guide/features/_meta.json Updates Chinese navigation to include ESM guide
website/docs/en/guide/features/_meta.json Updates English navigation to include ESM guide

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Comment thread website/docs/zh/guide/features/esm.mdx
Comment thread website/docs/en/guide/features/esm.mdx
Comment thread website/docs/zh/guide/features/esm.mdx
Comment thread website/docs/zh/guide/features/esm.mdx
Comment thread website/docs/en/guide/features/esm.mdx
Comment thread website/docs/en/guide/features/esm.mdx
JSerFeng
JSerFeng previously approved these changes Aug 20, 2025
Comment thread website/docs/en/guide/features/esm.mdx Outdated
Comment thread website/docs/en/guide/features/esm.mdx Outdated
Comment thread website/docs/zh/guide/features/esm.mdx Outdated
Comment thread website/docs/en/guide/features/esm.mdx Outdated
Comment thread website/docs/zh/guide/features/esm.mdx Outdated
Comment thread website/docs/en/guide/features/esm.mdx Outdated
fi3ework and others added 9 commits August 21, 2025 11:36
Co-authored-by: Fy <1114550440@qq.com>
Co-authored-by: neverland <chenjiahan.jait@bytedance.com>
Co-authored-by: neverland <chenjiahan.jait@bytedance.com>
Co-authored-by: neverland <chenjiahan.jait@bytedance.com>
Co-authored-by: neverland <chenjiahan.jait@bytedance.com>
Co-authored-by: neverland <chenjiahan.jait@bytedance.com>
Copy link
Copy Markdown
Member

@chenjiahan chenjiahan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏 awesome!

@chenjiahan chenjiahan merged commit 99bb1e4 into main Aug 21, 2025
25 checks passed
@chenjiahan chenjiahan deleted the esm-doc branch August 21, 2025 07:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

release: document release: document related release(mr only) team The issue/pr is created by the member of Rspack.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants