https://github.com/wxt-dev/examples
Collection of examples showing you how to use WXT to implement things in web extensions.
https://github.com/wxt-dev/examples
Last synced: over 1 year ago
JSON representation
Collection of examples showing you how to use WXT to implement things in web extensions.
- Host: GitHub
- URL: https://github.com/wxt-dev/examples
- Owner: wxt-dev
- Created: 2024-06-15T13:54:36.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-31T21:11:50.000Z (over 1 year ago)
- Last Synced: 2025-04-06T07:40:06.827Z (over 1 year ago)
- Language: TypeScript
- Size: 1.07 MB
- Stars: 55
- Watchers: 2
- Forks: 14
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# WXT Examples
Examples are available in the [`examples/` directory](./examples).
To download and run a specific example locally:
```sh
npx giget@latest gh:wxt-dev/examples examples/vue-overlay
cd vue-overlay
```
Then follow the directions in the example's README to run it.
## Contributing Examples
Want to create an example? Please do! Keep in mind that examples should be minimal, well documented, and easy to read. The README should contain basic information about starting the extension, and any addition information about what the example actually does.
The README needs to contain frontmatter, which is used to generate the `metadata.json` file. This file's raw contents is used by https://wxt.dev to create a [nice example search UI](https://wxt.dev/examples.html).
Before merging your PR, please update the `metadata.json` file by running the below command:
```sh
pnpm -w update-metadata
```
Review that the changes to the file look good, and you're good to merge :+1: