forked from web-infra-dev/rspack
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add README for every package (web-infra-dev#1947)
* docs: add README for every packages * docs: add more links to README * docs: update table
- Loading branch information
1 parent
6c22915
commit fdd1e9e
Showing
17 changed files
with
250 additions
and
9 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" srcset="https://lf3-static.bytednsdoc.com/obj/eden-cn/rjhwzy/ljhwZthlaukjlkulzlp/rspack-banner-1610-dark.png"> | ||
| <img alt="Rspack Banner" src="https://lf3-static.bytednsdoc.com/obj/eden-cn/rjhwzy/ljhwZthlaukjlkulzlp/rspack-banner-1610.png"> | ||
| </picture> | ||
|
|
||
| # @rspack/binding | ||
|
|
||
| Node binding for rspack. | ||
|
|
||
| ## Documentation | ||
|
|
||
| See [https://rspack.org](https://rspack.org) for details. | ||
|
|
||
| ## License | ||
|
|
||
| Rspack is [MIT licensed](https://github.com/modern-js-dev/rspack/blob/main/LICENSE). |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" srcset="https://lf3-static.bytednsdoc.com/obj/eden-cn/rjhwzy/ljhwZthlaukjlkulzlp/rspack-banner-1610-dark.png"> | ||
| <img alt="Rspack Banner" src="https://lf3-static.bytednsdoc.com/obj/eden-cn/rjhwzy/ljhwZthlaukjlkulzlp/rspack-banner-1610.png"> | ||
| </picture> | ||
|
|
||
| # @rspack/binding-darwin-arm64 | ||
|
|
||
| Node binding for rspack. | ||
|
|
||
| ## Documentation | ||
|
|
||
| See [https://rspack.org](https://rspack.org) for details. | ||
|
|
||
| ## License | ||
|
|
||
| Rspack is [MIT licensed](https://github.com/modern-js-dev/rspack/blob/main/LICENSE). |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" srcset="https://lf3-static.bytednsdoc.com/obj/eden-cn/rjhwzy/ljhwZthlaukjlkulzlp/rspack-banner-1610-dark.png"> | ||
| <img alt="Rspack Banner" src="https://lf3-static.bytednsdoc.com/obj/eden-cn/rjhwzy/ljhwZthlaukjlkulzlp/rspack-banner-1610.png"> | ||
| </picture> | ||
|
|
||
| # @rspack/binding-darwin-x64 | ||
|
|
||
| Node binding for rspack. | ||
|
|
||
| ## Documentation | ||
|
|
||
| See [https://rspack.org](https://rspack.org) for details. | ||
|
|
||
| ## License | ||
|
|
||
| Rspack is [MIT licensed](https://github.com/modern-js-dev/rspack/blob/main/LICENSE). |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" srcset="https://lf3-static.bytednsdoc.com/obj/eden-cn/rjhwzy/ljhwZthlaukjlkulzlp/rspack-banner-1610-dark.png"> | ||
| <img alt="Rspack Banner" src="https://lf3-static.bytednsdoc.com/obj/eden-cn/rjhwzy/ljhwZthlaukjlkulzlp/rspack-banner-1610.png"> | ||
| </picture> | ||
|
|
||
| # @rspack/binding-linux-x64-gnu | ||
|
|
||
| Node binding for rspack. | ||
|
|
||
| ## Documentation | ||
|
|
||
| See [https://rspack.org](https://rspack.org) for details. | ||
|
|
||
| ## License | ||
|
|
||
| Rspack is [MIT licensed](https://github.com/modern-js-dev/rspack/blob/main/LICENSE). |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" srcset="https://lf3-static.bytednsdoc.com/obj/eden-cn/rjhwzy/ljhwZthlaukjlkulzlp/rspack-banner-1610-dark.png"> | ||
| <img alt="Rspack Banner" src="https://lf3-static.bytednsdoc.com/obj/eden-cn/rjhwzy/ljhwZthlaukjlkulzlp/rspack-banner-1610.png"> | ||
| </picture> | ||
|
|
||
| # @rspack/binding-win32-x64-msvc | ||
|
|
||
| Node binding for rspack. | ||
|
|
||
| ## Documentation | ||
|
|
||
| See [https://rspack.org](https://rspack.org) for details. | ||
|
|
||
| ## License | ||
|
|
||
| Rspack is [MIT licensed](https://github.com/modern-js-dev/rspack/blob/main/LICENSE). |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" srcset="https://lf3-static.bytednsdoc.com/obj/eden-cn/rjhwzy/ljhwZthlaukjlkulzlp/rspack-banner-1610-dark.png"> | ||
| <img alt="Rspack Banner" src="https://lf3-static.bytednsdoc.com/obj/eden-cn/rjhwzy/ljhwZthlaukjlkulzlp/rspack-banner-1610.png"> | ||
| </picture> | ||
|
|
||
| # create-rspack | ||
|
|
||
| Create a new rspack project. | ||
|
|
||
| ## Documentation | ||
|
|
||
| See [https://rspack.org](https://rspack.org) for details. | ||
|
|
||
| ## License | ||
|
|
||
| Rspack is [MIT licensed](https://github.com/modern-js-dev/rspack/blob/main/LICENSE). |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" srcset="https://lf3-static.bytednsdoc.com/obj/eden-cn/rjhwzy/ljhwZthlaukjlkulzlp/rspack-banner-1610-dark.png"> | ||
| <img alt="Rspack Banner" src="https://lf3-static.bytednsdoc.com/obj/eden-cn/rjhwzy/ljhwZthlaukjlkulzlp/rspack-banner-1610.png"> | ||
| </picture> | ||
|
|
||
| # @rspack/postcss-loader | ||
|
|
||
| PostCSS loader for rspack. | ||
|
|
||
| ## Documentation | ||
|
|
||
| See [https://rspack.org](https://rspack.org) for details. | ||
|
|
||
| ## License | ||
|
|
||
| Rspack is [MIT licensed](https://github.com/modern-js-dev/rspack/blob/main/LICENSE). |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" srcset="https://lf3-static.bytednsdoc.com/obj/eden-cn/rjhwzy/ljhwZthlaukjlkulzlp/rspack-banner-1610-dark.png"> | ||
| <img alt="Rspack Banner" src="https://lf3-static.bytednsdoc.com/obj/eden-cn/rjhwzy/ljhwZthlaukjlkulzlp/rspack-banner-1610.png"> | ||
| </picture> | ||
|
|
||
| # @rspack/cli | ||
|
|
||
| Command-line interface for rspack. | ||
|
|
||
| ## Documentation | ||
|
|
||
| See [https://rspack.org](https://rspack.org) for details. | ||
|
|
||
| ## License | ||
|
|
||
| Rspack is [MIT licensed](https://github.com/modern-js-dev/rspack/blob/main/LICENSE). |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" srcset="https://lf3-static.bytednsdoc.com/obj/eden-cn/rjhwzy/ljhwZthlaukjlkulzlp/rspack-banner-1610-dark.png"> | ||
| <img alt="Rspack Banner" src="https://lf3-static.bytednsdoc.com/obj/eden-cn/rjhwzy/ljhwZthlaukjlkulzlp/rspack-banner-1610.png"> | ||
| </picture> | ||
|
|
||
| # @rspack/dev-client | ||
|
|
||
| Development client for rspack. | ||
|
|
||
| ## Documentation | ||
|
|
||
| See [https://rspack.org](https://rspack.org) for details. | ||
|
|
||
| ## License | ||
|
|
||
| Rspack is [MIT licensed](https://github.com/modern-js-dev/rspack/blob/main/LICENSE). |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,16 @@ | ||
| # rspack-dev-middleware | ||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" srcset="https://lf3-static.bytednsdoc.com/obj/eden-cn/rjhwzy/ljhwZthlaukjlkulzlp/rspack-banner-1610-dark.png"> | ||
| <img alt="Rspack Banner" src="https://lf3-static.bytednsdoc.com/obj/eden-cn/rjhwzy/ljhwZthlaukjlkulzlp/rspack-banner-1610.png"> | ||
| </picture> | ||
|
|
||
| An express middleware for rspack. | ||
| # @rspack/dev-middleware | ||
|
|
||
| Development middleware for rspack. | ||
|
|
||
| ## Documentation | ||
|
|
||
| See [https://rspack.org](https://rspack.org) for details. | ||
|
|
||
| ## License | ||
|
|
||
| Rspack is [MIT licensed](https://github.com/modern-js-dev/rspack/blob/main/LICENSE). |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,16 @@ | ||
| # rspack-dev-server | ||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" srcset="https://lf3-static.bytednsdoc.com/obj/eden-cn/rjhwzy/ljhwZthlaukjlkulzlp/rspack-banner-1610-dark.png"> | ||
| <img alt="Rspack Banner" src="https://lf3-static.bytednsdoc.com/obj/eden-cn/rjhwzy/ljhwZthlaukjlkulzlp/rspack-banner-1610.png"> | ||
| </picture> | ||
|
|
||
| # @rspack/dev-server | ||
|
|
||
| Development server for rspack. | ||
|
|
||
| ## Documentation | ||
|
|
||
| See [https://rspack.org](https://rspack.org) for details. | ||
|
|
||
| ## License | ||
|
|
||
| Rspack is [MIT licensed](https://github.com/modern-js-dev/rspack/blob/main/LICENSE). |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,16 @@ | ||
| # `@rspack/plugin-html` | ||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" srcset="https://lf3-static.bytednsdoc.com/obj/eden-cn/rjhwzy/ljhwZthlaukjlkulzlp/rspack-banner-1610-dark.png"> | ||
| <img alt="Rspack Banner" src="https://lf3-static.bytednsdoc.com/obj/eden-cn/rjhwzy/ljhwZthlaukjlkulzlp/rspack-banner-1610.png"> | ||
| </picture> | ||
|
|
||
| Modified from `html-webpack-plugin`. | ||
| # @rspack/plugin-html | ||
|
|
||
| HTML plugin for rspack, Modified from [jantimon/html-webpack-plugin](https://github.com/jantimon/html-webpack-plugin). | ||
|
|
||
| ## Documentation | ||
|
|
||
| See [https://rspack.org](https://rspack.org) for details. | ||
|
|
||
| ## License | ||
|
|
||
| Rspack is [MIT licensed](https://github.com/modern-js-dev/rspack/blob/main/LICENSE). |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" srcset="https://lf3-static.bytednsdoc.com/obj/eden-cn/rjhwzy/ljhwZthlaukjlkulzlp/rspack-banner-1610-dark.png"> | ||
| <img alt="Rspack Banner" src="https://lf3-static.bytednsdoc.com/obj/eden-cn/rjhwzy/ljhwZthlaukjlkulzlp/rspack-banner-1610.png"> | ||
| </picture> | ||
|
|
||
| # @rspack/plugin-minify | ||
|
|
||
| Minify plugin for rspack. | ||
|
|
||
| ## Documentation | ||
|
|
||
| See [https://rspack.org](https://rspack.org) for details. | ||
|
|
||
| ## License | ||
|
|
||
| Rspack is [MIT licensed](https://github.com/modern-js-dev/rspack/blob/main/LICENSE). |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,16 @@ | ||
| # node polyfill | ||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" srcset="https://lf3-static.bytednsdoc.com/obj/eden-cn/rjhwzy/ljhwZthlaukjlkulzlp/rspack-banner-1610-dark.png"> | ||
| <img alt="Rspack Banner" src="https://lf3-static.bytednsdoc.com/obj/eden-cn/rjhwzy/ljhwZthlaukjlkulzlp/rspack-banner-1610.png"> | ||
| </picture> | ||
|
|
||
| # @rspack/plugin-node-polyfill | ||
|
|
||
| Node polyfill plugin for rspack. | ||
|
|
||
| ## Documentation | ||
|
|
||
| See [https://rspack.org](https://rspack.org) for details. | ||
|
|
||
| ## License | ||
|
|
||
| Rspack is [MIT licensed](https://github.com/modern-js-dev/rspack/blob/main/LICENSE). |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,16 @@ | ||
| # rspack | ||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" srcset="https://lf3-static.bytednsdoc.com/obj/eden-cn/rjhwzy/ljhwZthlaukjlkulzlp/rspack-banner-1610-dark.png"> | ||
| <img alt="Rspack Banner" src="https://lf3-static.bytednsdoc.com/obj/eden-cn/rjhwzy/ljhwZthlaukjlkulzlp/rspack-banner-1610.png"> | ||
| </picture> | ||
|
|
||
| # @rspack/core | ||
|
|
||
| A Fast Rust-based Web Bundler. | ||
|
|
||
| ## Documentation | ||
|
|
||
| See [https://rspack.org](https://rspack.org) for details. | ||
|
|
||
| ## License | ||
|
|
||
| Rspack is [MIT licensed](https://github.com/modern-js-dev/rspack/blob/main/LICENSE). |