Skip to content

chore: better README on the Astro package #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Nsttt merged 2 commits into from
Apr 9, 2026
Merged

chore: better README on the Astro package #7

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
990269d
docs: add beta feedback callout to readme
Nsttt Apr 9, 2026
ba5935c
docs: make readme package-first
Nsttt Apr 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 22 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
# Astro Module Federation

Repo: `module-federation/astro`
Use Module Federation in Astro apps with `@module-federation/astro`, built on top of `@module-federation/vite`.

Workspace orchestration: Turborepo (`turbo` + `turbo.json`).
Plugin build: `tsdown` (`packages/astro/tsdown.config.ts`).
> [!IMPORTANT]
> `@module-federation/astro` is still in beta. Expect rough edges and API changes while the integration settles. Feedback, bugs, and edge cases are welcome in GitHub Issues for this repo.

Module Federation plugin: `@module-federation/vite`.
Astro bridge package in this repo: `@module-federation/astro`.
Published package source: `packages/astro`.
Example apps: `apps/example` (see `apps/example/README.md`).
## What you get

- Astro integration wrapper around Module Federation for host/remote setups.
- Dev/runtime wiring so `.astro` script imports and SSR remote imports work.
- Support for remote Astro components, server functions, and browser-side widgets.

## Package usage

Expand All @@ -28,6 +29,13 @@ export default defineConfig({
});
```

## Example apps

- Host app: `apps/example/host` on `http://localhost:4321`
- Remote app: `apps/example/remote` on `http://localhost:4322`
- Start both from repo root with `pnpm dev`
- More example details: `apps/example/README.md`

## Behavior

- Remote strings are normalized to explicit MF remote objects.
Expand Down Expand Up @@ -57,3 +65,10 @@ pnpm --filter @module-federation/astro test
- `mf-vite` already emits `ssrRemoteEntry` in its manifest, and MF runtime prefers that entry on the server.
- Rsbuild/Rslib providers should emit SSR assets with `target: 'dual'` (or legacy `ssr: true`).
- Astro as consumer keeps using MF runtime on the server; the loaded module can then be rendered as `<Component />` if it exports a server-renderable component.

## Repo layout

- Package: `packages/astro`
- Example apps: `apps/example`
- Main package README: `packages/astro/README.md`
- Release docs: `docs/RELEASING.md`
Loading