From 342c62c085b938b4d96e92b41b9a8f87e1cb6511 Mon Sep 17 00:00:00 2001 From: jxxghp Date: Sun, 14 Jun 2026 16:35:57 +0800 Subject: [PATCH] docs: update README files to include Module Federation documentation --- README.md | 18 +++++++++--------- README_EN.md | 16 +++++++--------- yarn.lock | 26 +++++--------------------- 3 files changed, 21 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index feb19883..539795bc 100644 --- a/README.md +++ b/README.md @@ -11,15 +11,6 @@ - 支持多语言（中文/英文） - 完整的插件系统支持，包括远程组件动态加载 -## 模块联邦功能 - -MoviePilot 现已支持模块联邦（Module Federation）功能，允许插件开发者创建可动态加载的远程组件，实现更丰富的插件用户界面。 - -### 相关文档 - -- [模块联邦开发指南](docs/module-federation-guide.md) - 如何开发远程组件插件 -- [模块联邦问题排查指南](docs/federation-troubleshooting.md) - 常见问题和解决方案 -- [插件远程组件示例](examples/plugin-component/) - 开发插件组件的完整示例项目 ## 开发部署 @@ -58,3 +49,12 @@ yarn build ```shell node dist/service.js ``` + + +### 模块联邦功能 + +MoviePilot 现已支持模块联邦（Module Federation）功能，允许插件开发者创建可动态加载的远程组件，实现更丰富的插件用户界面。 + +- [模块联邦开发指南](docs/module-federation-guide.md) - 如何开发远程组件插件 +- [模块联邦问题排查指南](docs/federation-troubleshooting.md) - 常见问题和解决方案 +- [插件远程组件示例](examples/plugin-component/) - 开发插件组件的完整示例项目 diff --git a/README_EN.md b/README_EN.md index f81dca90..ac3e3566 100644 --- a/README_EN.md +++ b/README_EN.md @@ -11,15 +11,6 @@ Frontend project for [MoviePilot](https://github.com/jxxghp/MoviePilot), NodeJS - Multi-language support (Chinese/English) - Complete plugin system with dynamic remote component loading -## Module Federation - -MoviePilot now supports Module Federation, allowing plugin developers to create dynamically loadable remote components for richer plugin user interfaces. - -### Documentation - -- [Module Federation Troubleshooting Guide](docs/federation-troubleshooting.md) - Common issues and solutions -- [Plugin Remote Component Example](examples/plugin-component/) - Complete example project for developing plugin components - ## Development ### Recommended IDE Setup @@ -57,3 +48,10 @@ yarn build ```shell node dist/service.js ``` + +### Module Federation + +MoviePilot now supports Module Federation, allowing plugin developers to create dynamically loadable remote components for richer plugin user interfaces. + +- [Module Federation Troubleshooting Guide](docs/federation-troubleshooting.md) - Common issues and solutions +- [Plugin Remote Component Example](examples/plugin-component/) - Complete example project for developing plugin components diff --git a/yarn.lock b/yarn.lock index 3b0434a9..c99f3534 100644 --- a/yarn.lock +++ b/yarn.lock @@ -3082,9 +3082,9 @@ camelcase@^5.0.0: integrity sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg== caniuse-lite@^1.0.30001688, caniuse-lite@^1.0.30001702: - version "1.0.30001761" - resolved "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001761.tgz" - integrity sha512-JF9ptu1vP2coz98+5051jZ4PwQgd2ni8A+gYSN7EA7dPKIMf0pDlSUxhdmVOaV3/fYK5uWBkgSXJaRLr4+3A6g== + version "1.0.30001799" + resolved "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001799.tgz" + integrity sha512-hG1bReV+OUU+MOqK4t/ZWI0tZOyz3rqS9XuhOUz1cIcbwBKjOyJEJuw9ER5JuNyqxNk8u/JUVbGibBOL1yrjFw== chalk@^4.0.0, chalk@^4.0.2: version "4.1.2" @@ -7007,16 +7007,7 @@ std-env@^3.9.0: resolved "https://registry.npmjs.org/std-env/-/std-env-3.9.0.tgz" integrity sha512-UGvjygr6F6tpH7o2qyqR6QYpwraIjKSdtzyBdyytFOHmPZY917kwdwLG0RbOjWOnKmnm3PeHjaoLLMie7kPLQw== -"string-width-cjs@npm:string-width@^4.2.0": - version "4.2.3" - resolved "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz" - integrity sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g== - dependencies: - emoji-regex "^8.0.0" - is-fullwidth-code-point "^3.0.0" - strip-ansi "^6.0.1" - -string-width@^4.1.0, string-width@^4.2.0, string-width@^4.2.3: +"string-width-cjs@npm:string-width@^4.2.0", string-width@^4.1.0, string-width@^4.2.0, string-width@^4.2.3: version "4.2.3" resolved "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz" integrity sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g== @@ -7101,14 +7092,7 @@ stringify-object@^3.3.0: is-obj "^1.0.1" is-regexp "^1.0.0" -"strip-ansi-cjs@npm:strip-ansi@^6.0.1": - version "6.0.1" - resolved "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz" - integrity sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A== - dependencies: - ansi-regex "^5.0.1" - -strip-ansi@^6.0.0, strip-ansi@^6.0.1: +"strip-ansi-cjs@npm:strip-ansi@^6.0.1", strip-ansi@^6.0.0, strip-ansi@^6.0.1: version "6.0.1" resolved "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz" integrity sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==