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: about 10 hours 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 (5 months ago)
• Default Branch: main
• Last Pushed: 2024-08-29T06:15:55.000Z (2 months ago)
• Last Synced: 2024-08-29T07:44:44.567Z (2 months ago)
• Language: TypeScript
• Size: 417 KB
• Stars: 15
• Watchers: 1
• Forks: 4
• Open Issues: 0
• 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: