Skip to content

Commit 526d9f4

Browse files
authored
docs: update examples link (#1246)
1 parent 19dca53 commit 526d9f4

File tree

12 files changed

+14
-20
lines changed

12 files changed

+14
-20
lines changed

website/docs/en/guide/advanced/module-federation.mdx

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
import MF from '../start/components/MF.mdx';
2-
import { Tab, Tabs } from 'rspress/theme';
32

43
# Module Federation
54

@@ -356,10 +355,8 @@ export default defineConfig({
356355

357356
## Examples
358357

359-
[Rslib Module Federation Example](https://github.com/web-infra-dev/rslib/tree/main/examples/module-federation)
358+
You can refer to the example projects in [Rslib Module Federation Example](https://github.com/rspack-contrib/rstack-examples/tree/main/rslib/module-federation).
360359

361360
- `mf-host`: Rsbuild App Consumer
362361
- `mf-react-component`: Rslib Module, which is both a producer and a consumer, provides the module to the `mf-host` as a producer, and consumes the `mf-remote`
363362
- `mf-remote`: Rsbuild App Producer
364-
365-
[Rslib Module Federation Storybook Example](https://github.com/web-infra-dev/rslib/tree/main/examples/module-federation/mf-react-component)

website/docs/en/guide/advanced/storybook.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,5 +98,5 @@ Check out more details in the [Storybook Rsbuild documentation](https://storyboo
9898

9999
## Example
100100

101-
- [React component library + Rslib + Storybook](https://github.com/rspack-contrib/storybook-rsbuild/tree/main/sandboxes/rslib-react-component)
102-
- [Vue component library + Rslib + Storybook](https://github.com/rspack-contrib/storybook-rsbuild/tree/main/sandboxes/rslib-vue3-component)
101+
- [React component library + Rslib + Storybook](https://github.com/rspack-contrib/rstack-examples/tree/main/rslib/react-storybook)
102+
- [Vue component library + Rslib + Storybook](https://github.com/rspack-contrib/rstack-examples/tree/main/rslib/vue-storybook)

website/docs/en/guide/solution/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ When developing a library that runs in the browser, you can package it in both [
88

99
When publishing to npm, you can choose not to [minify](/config/rsbuild/output#outputminify) your code or to minify it while providing a [sourcemap](/config/rsbuild/output#outputsourcemap) to enhance the debugging experience for users of your library. For styling, you can use CSS, or CSS pre-processors like Sass, Less, or Stylus, or apply PostCSS for CSS post-processing. Tools like Tailwind CSS can also help in building your styles. Using CSS Modules to create CSS modules is another option.
1010

11-
In terms of resource management, Rslib handles static assets used in your code, such as SVG and PNG files. You can also build a component library of [React](/guide/solution/react), [Preact](https://github.com/web-infra-dev/rslib/tree/main/examples/preact-component-bundle-false), or other frameworks, and use [Storybook](/guide/advanced/storybook) for UI component development and testing.
11+
In terms of resource management, Rslib handles static assets used in your code, such as SVG and PNG files. You can also build a component library of [React](/guide/solution/react), [Preact](https://github.com/rspack-contrib/rstack-examples/tree/main/rslib/preact), or other frameworks, and use [Storybook](/guide/advanced/storybook) for UI component development and testing.
1212

1313
Refer to the solutions in this chapter to learn how to use Rslib to develop browser libraries for different frameworks.
1414

website/docs/en/guide/solution/nodejs.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Node.js
22

3-
In this document, you will learn how to build a Node.js library using Rslib.
3+
In this document, you will learn how to build a Node.js library using Rslib. You can check out Node.js related example projects in [Examples](https://github.com/rspack-contrib/rstack-examples/tree/main/rslib).
44

55
## Create Node.js project
66

website/docs/en/guide/solution/react.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# React
22

3-
In this document, you will learn how to build a React component library with Rslib. You can check out React related demo projects in the [examples](https://github.com/web-infra-dev/rslib/tree/main/examples).
3+
In this document, you will learn how to build a React component library with Rslib. You can check out React related example projects in [Examples](https://github.com/rspack-contrib/rstack-examples/tree/main/rslib).
44

55
## Create React project
66

website/docs/en/guide/solution/vue.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Vue
22

3-
In this document, you will learn how to build a Vue component library using Rslib. You can check out Vue related demo projects in the [examples](https://github.com/web-infra-dev/rslib/tree/main/examples).
3+
In this document, you will learn how to build a Vue component library using Rslib. You can check out Vue related example projects in [Examples](https://github.com/rspack-contrib/rstack-examples/tree/main/rslib).
44

55
::: note
66

website/docs/zh/guide/advanced/module-federation.mdx

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
import MF from '../start/components/MF.mdx';
2-
import { Tab, Tabs } from 'rspress/theme';
32

43
# 模块联邦
54

@@ -355,10 +354,8 @@ export default defineConfig({
355354

356355
## 示例
357356

358-
[Rslib 模块联邦示例](https://github.com/web-infra-dev/rslib/tree/main/examples/module-federation)
357+
你可以在 [Rslib 模块联邦示例](https://github.com/rspack-contrib/rstack-examples/tree/main/rslib/module-federation) 中查看相关项目。
359358

360359
- `mf-host`: Rsbuild App 消费者
361360
- `mf-react-component`: Rslib Module, 同时是消费者和生产者, 作为生产者向 `mf-host` 提供模块, 并消费 `mf-remote`
362361
- `mf-remote`: Rsbuild App 生产者
363-
364-
[Rslib 模块联邦 Storybook 示例](https://github.com/web-infra-dev/rslib/tree/main/examples/module-federation/mf-react-component)

website/docs/zh/guide/advanced/storybook.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,5 +98,5 @@ npx storybook build // 构建静态文件
9898

9999
## 示例
100100

101-
- [React 组件库 + Rslib + Storybook](https://github.com/rspack-contrib/storybook-rsbuild/tree/main/sandboxes/rslib-react-component)
102-
- [Vue 组件库 + Rslib + Storybook](https://github.com/rspack-contrib/storybook-rsbuild/tree/main/sandboxes/vue3)
101+
- [React 组件库 + Rslib + Storybook](https://github.com/rspack-contrib/rstack-examples/tree/main/rslib/react-storybook)
102+
- [Vue 组件库 + Rslib + Storybook](https://github.com/rspack-contrib/rstack-examples/tree/main/rslib/vue-storybook)

website/docs/zh/guide/solution/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
发布到 npm 时,你可以选择不压缩代码或[压缩代码](/config/rsbuild/output#outputminify),同时提供[sourcemap](/config/rsbuild/output#outputsourcema) 以增强库使用者的调试体验。样式上,可以使用 CSS 或 CSS 预处理器,如 Sass、Less 或 Stylus 等,或使用 PostCSS 用于 CSS 后处理。 Tailwind CSS 等工具也可以帮助你构建样式,也可以使用 CSS Modules。
1010

11-
在资源处理方面,Rslib 处理代码中使用的静态资源,例如 SVG 和 PNG 文件。你还可以构建[React](/guide/solution/react)[Preact](https://github.com/web-infra-dev/rslib/tree/main/examples/preact-component-bundle-false) 或其他框架,使用 [Storybook](/guide/advanced/storybook) 进行 UI 组件开发和测试。
11+
在资源处理方面,Rslib 处理代码中使用的静态资源,例如 SVG 和 PNG 文件。你还可以构建[React](/guide/solution/react)[Preact](https://github.com/rspack-contrib/rstack-examples/tree/main/rslib/preact) 或其他框架,使用 [Storybook](/guide/advanced/storybook) 进行 UI 组件开发和测试。
1212

1313
参考本章的解决方案,了解如何使用 Rslib 开发一个在浏览器中使用的库,给多种框架使用。
1414

website/docs/zh/guide/solution/nodejs.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Node.js
22

3-
在本文档中,你将学习如何使用 Rslib 构建 Node.js 库。
3+
在本文档中,你将学习如何使用 Rslib 构建 Node.js 库,你可在 [示例](https://github.com/rspack-contrib/rstack-examples/tree/main/rslib) 中查看 Node.js 相关演示项目
44

55
## 创建 Node.js 项目
66

0 commit comments

Comments
 (0)