Skip to content

Latest commit

 

History

History
116 lines (85 loc) · 4.18 KB

README.zh-CN.md

File metadata and controls

116 lines (85 loc) · 4.18 KB

plasmo logo

See License NPM Install Follow PlasmoHQ on Twitter Watch our Live DEMO every Friday Join our Discord for support and chat about our projects

English | 简体中文 | Tiếng Việt

Plasmo 框架

Plasmo 框架是骇客为骇客制作的一个强力的浏览器扩展 SDK。构建您的产品,无需担心配置文件编写和构建浏览器扩展时的奇怪特性。

它就像浏览器扩展界的 Next.js

CLI Demo

特性

系统要求

  • Node.js 16.x 及以上
  • MacOS,Windows,或 Linux
  • (强烈推荐) pnpm

例子

我们有一些展示如何集成 Firebase AuthenticationReduxSupabase authenticationTailwind 以及更多技术的示例。若要浏览全部示例,请访问示例仓库

文档

阅读文档以更深入地了解 Plasmo 框架。

使用

pnpm dlx plasmo init example-dir
cd example-dir
pnpm dev

注意

  • Popup 改动应在 popup.tsx
  • Options 页面改动应在 options.tsx
  • Content script 改动应在 content.ts
  • Background service worker 改动应在 background.ts

目录

您还可以在它们各自的目录中组织这些文件:

ext-dir
├───assets
|   └───icon512.png
├───popup
|   ├───index.tsx
|   └───button.tsx
├───options
|   ├───index.tsx
|   ├───utils.ts
|   └───input.tsx
├───contents
|   ├───site-one.ts
|   ├───site-two.ts
|   └───site-three.ts
...

此外,您也能够将代码放到 src 子目录,而不将它们放到根目录,请参阅该指南。注意 assets 和其他配置文件仍须在根目录下。

社区

可以在 Discord 找到 Plasmo 社区。这是获得 Plasmo 框架使用帮助的恰当渠道。

我们的 行为守则 适用于所有 Plasmo 社区频道。

贡献

请参阅 贡献指南 以了解更多。

免责声明

Plasmo 当前仍为 alpha 软件,且不同版本间可能存在修改,所以在使用过程中请留意,风险自负。

协议

MITPlasmo