Skip to content

Commit 97c67f3

Browse files
docs: refresh advanced api overview (#4366)
1 parent 6241fe6 commit 97c67f3

File tree

1 file changed

+23
-4
lines changed

1 file changed

+23
-4
lines changed

advanced-api/README.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,27 @@
11
# Advanced API
22

3-
This leverages pre-release implementations of Webpack 5 Module Federation's new advanced API
3+
Examples in this directory showcase early implementations of advanced Module Federation features. Each subfolder is a standalone example with its own documentation.
44

5-
There are several configurations in here
5+
## Available examples
66

7-
- Dynamic Remotes
8-
- The ability to dynamically load and share code between remotes that are unknown to the host at build time.
7+
- [Automatic Vendor Sharing](./automatic-vendor-sharing/README.md) – automatically detect and share common dependencies across federated builds.
8+
- [Dynamic Remotes](./dynamic-remotes/README.md) – dynamically load and share code from remotes that aren't known to the host at build time.
9+
- [Dynamic Remotes with Runtime Environment Variables](./dynamic-remotes-runtime-environment-variables/README.md) – configure remote URLs via runtime-provided environment variables and container-friendly setups.
10+
- [Dynamic Remotes with Synchronous Imports](./dynamic-remotes-synchronous-imports/README.md) – change remote URLs at runtime while keeping static import syntax like `import Widget from 'app2/Widget'`.
11+
12+
## Getting started
13+
14+
Install dependencies at the repository root:
15+
16+
```bash
17+
pnpm install
18+
```
19+
20+
Then run or build any example from its folder, e.g.:
21+
22+
```bash
23+
pnpm --filter automatic-vendor-sharing_* start
24+
pnpm --filter dynamic-remotes_* build
25+
```
26+
27+
See each example's README for detailed instructions.

0 commit comments

Comments
 (0)