chore(release): @wxt-dev/analytics v0.5.0

Co-authored-by: Aaron <aaronklinker1@gmail.com>

.codecov.yml

@@ -0,0 +1,8 @@
+coverage:
+  status:
+    project:
+      default:
+        informational: true
+    patch:
+      default:
+        informational: true

.commitlintrc.yml

@@ -0,0 +1,10 @@
+extends:
+  - '@commitlint/config-conventional'
+rules:
+  subject-case:
+    - 0
+    - always
+    - - sentence-case
+      - start-case
+      - pascal-case
+      - upper-case

.gitattributes

@@ -1,2 +1,16 @@
+# See https://git-scm.com/docs/gitattributes#_pattern_format for more about `.gitattributes`.
+
+# Normalize EOL for all files that Git considers text files
 * text=auto eol=lf
+
+# Mark lock files as generated to avoid diffing
 pnpm-lock.yaml linguist-generated
+package-lock.json linguist-generated
+bun.lockb linguist-generated
+yarn.lock linguist-generated
+
+# Exclude templates from language statistics
+templates/**/* linguist-vendored
+
+# Other generated files
+packages/browser/src/gen/** linguist-generated

.github/CODEOWNERS

@@ -0,0 +1,9 @@
+# Set default
+* @aklinker1 @Timeraa
+
+# Secure Directories
+/.github/ @aklinker1
+
+# Creator of specific wxt modules
+/packages/auto-icons/ @Timeraa
+/packages/unocss/ @Timeraa

.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository#about-funding-files
+
+github: wxt-dev

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,75 @@
+name: "\U0001F41E Bug report"
+description: Report an issue with WXT
+labels: [pending-triage]
+type: Bug
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: textarea
+    id: bug-description
+    attributes:
+      label: Describe the bug
+      description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description. Thanks!
+      placeholder: I am doing ... What I expect is ... What actually happening is ...
+    validations:
+      required: true
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Reproduction
+      description: |
+        Please provide a minimal reproduction. This can include:
+
+        - A PR with a failing test case
+        - A link to a github repo
+        - A ZIP you upload to this issue
+
+        A [minimal reproduction](https://stackoverflow.com/help/minimal-reproducible-example) is required ([Why?](https://antfu.me/posts/why-reproductions-are-required)). If a report is vague (e.g. just a generic error message) and has no reproduction or a partial reproduction, it will be closed immediately and labeled with as "needs-reproduction". Once a reproduction is provided, it will be re-opened.
+      placeholder: Reproduction URL or attach a ZIP
+    validations:
+      required: true
+  - type: textarea
+    id: reproduction-steps
+    attributes:
+      label: Steps to reproduce
+      description: Please provide any reproduction steps that may need to be described. E.g. if it happens only when running the dev or build script make sure it's clear which one to use.
+      placeholder: Run `npm install` followed by `npm run dev`
+  - type: textarea
+    id: system-info
+    attributes:
+      label: System Info
+      description: Output of `npx envinfo --system --browsers --binaries --npmPackages wxt,vite`
+      render: shell
+      placeholder: System, Binaries, Browsers
+    validations:
+      required: true
+  - type: dropdown
+    id: package-manager
+    attributes:
+      label: Used Package Manager
+      description: Select the used package manager
+      options:
+        - npm
+        - yarn
+        - pnpm
+        - bun
+    validations:
+      required: true
+  - type: checkboxes
+    id: checkboxes
+    attributes:
+      label: Validations
+      description: Before submitting the issue, please make sure you do the following
+      options:
+        - label: Read the [Contributing Guidelines](https://github.com/wxt-dev/wxt/blob/main/CONTRIBUTING.md).
+          required: true
+        - label: Read the [docs](https://wxt.dev/guide/installation.html).
+          required: true
+        - label: Check that there isn't [already an issue](https://github.com/wxt-dev/wxt/issues) that reports the same bug to avoid creating a duplicate.
+          required: true
+        - label: Check that this is a concrete bug. For Q&A open a [GitHub Discussion](https://github.com/wxt-dev/wxt/discussions) or join our [Discord Chat Server](https://discord.gg/ZFsZqGery9).
+          required: true
+        - label: The provided reproduction is a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) of the bug.
+          required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Discord Chat
+    url: https://discord.gg/ZFsZqGery9
+    about: Ask questions and discuss with other WXT users in real time.
+  - name: Questions & Discussions
+    url: https://github.com/wxt-dev/wxt/discussions
+    about: Use GitHub discussions for message-board style questions and discussions.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,23 @@
+---
+name: Feature request
+about: Suggest an idea for WXT
+title: ''
+type: Feature
+assignees: ''
+---
+
+### Feature Request
+
+Please describe your feature, be clear and concise. If you have a proposal for required type or API changes, list them here.
+
+#### Is your feature request related to a bug?
+
+If so, add a link here. If not, write "N/A"
+
+### What are the alternatives?
+
+A clear and concise description of any alternative solutions or features you've considered.
+
+### Additional context
+
+Add any other context or screenshots about the feature request here.

.github/actions/setup/action.yml

@@ -0,0 +1,31 @@
+name: Basic Setup
+description: Install PNPM, Node, and dependencies
+
+inputs:
+  install:
+    default: 'true'
+    type: boolean
+    description: Whether or not to run 'pnpm install'
+
+  installArgs:
+    default: ''
+    type: string
+    description: Additional args to append to "pnpm install"
+
+runs:
+  using: composite
+
+  steps:
+    - name: 🛠️ Setup PNPM
+      uses: pnpm/action-setup@v4
+
+    - name: 🛠️ Setup NodeJS
+      uses: actions/setup-node@v4
+      with:
+        node-version: 18
+        cache: pnpm
+
+    - name: 📦 Install Dependencies
+      if: ${{ inputs.install == 'true' }}
+      shell: bash
+      run: pnpm install ${{ inputs.installArgs }}

.github/dependabot.yml

@@ -0,0 +1,15 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: npm
+    directory: /
+    schedule:
+      interval: 'monthly'
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+      interval: 'monthly'

.github/pull_request_template.md

@@ -0,0 +1,13 @@
+### Overview
+
+<!-- Describe your changes and why you made them -->
+
+### Manual Testing
+
+<!-- Describe how to test your changes to make sure the PR works as intended -->
+
+### Related Issue
+
+<!-- If this PR is related to an issue, please link it here -->
+
+This PR closes #<issue_number>

.github/workflows/pkg.pr.new.yml

@@ -0,0 +1,29 @@
+name: ✨ pkg.pr.new
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Publish Test Packages
+    runs-on: ubuntu-22.04
+    if: ${{ github.repository == 'wxt-dev/wxt' }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup
+        uses: ./.github/actions/setup
+
+      - name: Build All Packages
+        run: pnpm buildc all
+
+      - name: Publish
+        run: pnpx pkg-pr-new publish --compact --pnpm './packages/*'

.github/workflows/pr-closed.yml

@@ -0,0 +1,29 @@
+name: 🎉 PR closed
+
+on:
+  pull_request_target:
+    types:
+      - closed
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  thank-you:
+    runs-on: ubuntu-latest
+    if: github.event.pull_request.merged == true
+
+    steps:
+      - name: Post Thank You Comment
+        uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
+        env:
+          comment: Thanks for helping make WXT better!
+        with:
+          script: |
+            github.rest.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: process.env.comment
+            })

.github/workflows/pr-title.yml

@@ -0,0 +1,26 @@
+name: 🛡️ Check PR Title
+
+on:
+  pull_request:
+    types: [opened, edited]
+
+jobs:
+  lint-pr-title:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          # Only fetch the config file from the repository
+          sparse-checkout-cone-mode: false
+          sparse-checkout: .commitlintrc.yml
+
+      - name: Install dependencies
+        run: npm install --global @commitlint/config-conventional commitlint
+
+      - name: Check PR title with commitlint
+        env:
+          PR_TITLE: ${{ github.event.pull_request.title }}
+          HELP_URL: https://github.com/wxt-dev/wxt/blob/main/CONTRIBUTING.md#conventional-pr-titles
+        run: echo "$PR_TITLE" | npx commitlint --help-url $HELP_URL

.github/workflows/publish-docs.yml

@@ -0,0 +1,47 @@
+name: 📝 Publish Docs
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: Docker Image Tag
+        required: true
+        default: latest
+
+permissions:
+  contents: read
+
+jobs:
+  publish:
+    # Only run if it's the upstream repository, not forks
+    if: github.repository == 'wxt-dev/wxt'
+    name: Publish Docs
+    runs-on: ubuntu-22.04
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup
+        uses: ./.github/actions/setup
+
+      - name: Login to Docker Registry
+        uses: docker/login-action@v3
+        with:
+          registry: https://${{ secrets.DOCKER_REGISTRY_HOSTNAME }}
+          username: ${{ secrets.DOCKER_REGISTRY_USERNAME }}
+          password: ${{ secrets.DOCKER_REGISTRY_PASSWORD }}
+
+      - name: Build docs
+        run: |
+          pnpm docs:build
+          docker build docs/.vitepress -t ${{ secrets.DOCKER_REGISTRY_HOSTNAME }}/wxt/docs:${{ github.event.inputs.tag || 'latest' }}
+
+      - name: Push Image
+        run: docker push ${{ secrets.DOCKER_REGISTRY_HOSTNAME }}/wxt/docs:${{ github.event.inputs.tag || 'latest' }}
+
+      - name: Deploy
+        run: curl -X POST -i ${{ secrets.UPDATE_DOCS_WEBHOOK }}

.github/workflows/release.yml

@@ -1,50 +1,69 @@
-name: Release
+name: 🚀 Release
 on:
   workflow_dispatch:
+    inputs:
+      package:
+        description: Package to release
+        default: wxt
+        type: choice
+        options:
+          - analytics
+          - auto-icons
+          - i18n
+          - module-react
+          - module-solid
+          - module-svelte
+          - module-vue
+          - storage
+          - unocss
+          - webextension-polyfill
+          - wxt
+
+permissions:
+  contents: read
 
 jobs:
   validate:
+    name: Validate
     uses: './.github/workflows/validate.yml'
+    secrets: inherit
 
   publish:
-    runs-on: ubuntu-20.04
+    name: Publish
+    runs-on: ubuntu-22.04
+    permissions:
+      contents: write
     needs:
       - validate
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
-      - name: Setup PNPM
-        uses: pnpm/action-setup@v2
-        with:
-          version: 7
+      - name: Setup
+        uses: ./.github/actions/setup
 
-      - name: Setup NodeJS
-        uses: actions/setup-node@v3
-        with:
-          node-version: 18
-          cache: 'pnpm'
-
-      - name: Install dependencies
+      - name: Configure Git
         run: |
-          pnpm install --ignore-scripts
-          pnpm build
-          pnpm install
+          git config user.name 'github-actions[bot]'
+          git config user.email 'github-actions[bot]@users.noreply.github.com'
+          git config --global push.followTags true
 
       - name: Bump and Tag
         run: |
-          git config user.email "github-actions@users.noreply.github.com"
-          git config user.name "GitHub Actions"
-          pnpx changelogen@latest --release
+          pnpm tsx scripts/bump-package-version.ts ${{ inputs.package }}
           git push
           git push --tags
 
-      - name: NPM
+      - name: Publish to NPM
+        working-directory: packages/${{ inputs.package }}
         run: |
           echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_AUTH_TOKEN }}" > ~/.npmrc
+          pnpm build
           pnpm publish
 
-      - name: GitHub Release
-        run: pnpx changelogen@latest gh release
+      - name: Create GitHub release
+        run: pnpm tsx scripts/create-github-release.ts ${{ inputs.package }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/sync-releases.yml

@@ -0,0 +1,42 @@
+name: 🔄 Sync Releases
+on:
+  workflow_dispatch:
+    inputs:
+      package:
+        description: Package to sync
+        default: wxt
+        type: choice
+        options:
+          - analytics
+          - auto-icons
+          - i18n
+          - module-react
+          - module-solid
+          - module-svelte
+          - module-vue
+          - storage
+          - webextension-polyfill
+          - wxt
+
+permissions:
+  contents: read
+
+jobs:
+  sync:
+    name: Sync Releases
+    runs-on: ubuntu-22.04
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup
+        uses: ./.github/actions/setup
+        with:
+          installArgs: --ignore-scripts
+
+      - name: Sync Releases
+        run: pnpm tsx scripts/sync-releases.ts ${{ inputs.package }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/update-browser-package.yml

@@ -0,0 +1,47 @@
+name: 🔄 Update @wxt-dev/browser
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 0 * * *' # Every day at midnight
+
+permissions:
+  contents: read
+
+jobs:
+  sync:
+    name: 'Sync with @types/chrome'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup
+        uses: ./.github/actions/setup
+        with:
+          installArgs: --ignore-scripts
+
+      - name: Generate Latest Code
+        working-directory: packages/browser
+        run: pnpm gen
+
+      - name: Run Checks
+        working-directory: packages/browser
+        run: pnpm check
+
+      - name: Commit Changes
+        id: commit
+        uses: stefanzweifel/git-auto-commit-action@v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          commit_message: 'fix: Upgrade \`@wxt-dev/browser\` to latest \`@types/chrome\` version'
+          file_pattern: 'packages/browser/**'
+
+      - name: Publish Package
+        if: steps.commit.outputs.changes_detected == 'true'
+        working-directory: packages/browser
+        run: |
+          echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_AUTH_TOKEN }}" > ~/.npmrc
+          pnpm publish

.github/workflows/validate.yml

@@ -1,4 +1,4 @@
-name: Validate
+name: 🛡️ Validate
 on:
   workflow_call:
   pull_request:
@@ -6,43 +6,129 @@ on:
     branches:
       - main
 
+permissions:
+  contents: read
+
 jobs:
-  validate:
-    runs-on: ubuntu-20.04
+  checks:
+    name: Checks
+    runs-on: ubuntu-22.04
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
-      - name: Setup PNPM
-        uses: pnpm/action-setup@v2
-        with:
-          version: 7
+      - name: Setup
+        uses: ./.github/actions/setup
 
-      - name: Setup NodeJS
-        uses: actions/setup-node@v3
-        with:
-          node-version: 18
-          cache: 'pnpm'
+      - name: Basic Checks
+        run: pnpm check
 
-      - name: Install dependencies
-        run: |
-          pnpm install --ignore-scripts
-          pnpm build
-          pnpm install
+  builds:
+    name: Builds
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
 
-      - name: Formatting
-        run: pnpm format:check
+      - name: Setup
+        uses: ./.github/actions/setup
 
-      - name: Type Check
+      - name: Build All Packages
+        run: pnpm buildc all
+
+  build-demo:
+    name: Build Demo
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup
+        uses: ./.github/actions/setup
+
+      - name: Build
+        run: pnpm build:all
+        working-directory: packages/wxt-demo
+
+      - name: ZIP
+        run: pnpm wxt zip
+        working-directory: packages/wxt-demo
+
+  tests:
+    name: Tests
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup
+        uses: ./.github/actions/setup
+
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v2
+
+      - name: Run Tests
+        run: pnpm test:coverage -- --reporter=default --reporter=hanging-process
+
+      - name: Upload Coverage
+        uses: codecov/codecov-action@v5
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
+  windows-tests:
+    name: Windows Tests
+    runs-on: windows-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup
+        uses: ./.github/actions/setup
+
+      - name: Run Tests
+        run: pnpm test
+
+  template:
+    name: Template
+    runs-on: ubuntu-22.04
+    strategy:
+      fail-fast: false
+      matrix:
+        template:
+          - react
+          - solid
+          - svelte
+          - vanilla
+          - vue
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup
+        uses: ./.github/actions/setup
+
+      - name: Pack WXT package
+        run: pnpm pack
+        working-directory: packages/wxt
+
+      - name: Install Dependencies
+        run: npm i
+        working-directory: templates/${{ matrix.template }}
+
+      - name: Install Packed WXT
+        run: npm i -D ../../packages/wxt/wxt-*.tgz
+        working-directory: templates/${{ matrix.template }}
+
+      - name: Type Check Template
         run: pnpm compile
+        if: matrix.template != 'svelte'
+        working-directory: templates/${{ matrix.template }}
 
-      - name: Build Demo
-        run: |
-          pnpm build:all:chrome-mv2
-          pnpm build:all:chrome-mv3
-          pnpm build:all:firefox-mv2
-          pnpm build:all:firefox-mv3
-        working-directory: demo
+      - name: Type Check Template
+        run: pnpm check
+        if: matrix.template == 'svelte'
+        working-directory: templates/${{ matrix.template }}
 
-      - name: Tests
-        run: pnpm test:coverage
+      - name: Build Template
+        run: pnpm build
+        working-directory: templates/${{ matrix.template }}

.github/workflows/vhs.yml

@@ -0,0 +1,45 @@
+name: 📼 VHS
+on:
+  push:
+    paths:
+      - 'docs/tapes/*.tape'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  vhs:
+    name: Create VHS
+    runs-on: ubuntu-22.04
+    if: ${{ github.repository == 'wxt-dev/wxt' }}
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup
+        uses: ./.github/actions/setup
+        with:
+          install: false
+
+      # This prevents pnpm dlx from downloading WXT in the video
+      - name: Pre-install WXT
+        run: |
+          pnpm store add wxt@latest
+          pnpm dlx wxt@latest --version
+
+      - name: Record VHS
+        uses: charmbracelet/vhs-action@v2.1.0
+        with:
+          path: 'docs/tapes/init-demo.tape'
+
+      - name: Save recorded GIF
+        uses: stefanzweifel/git-auto-commit-action@v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          commit_message: 'docs: Update `wxt init` GIF'
+          # https://github.com/charmbracelet/vhs#output
+          file_pattern: 'docs/assets/*.gif'

.gitignore

@@ -6,12 +6,18 @@
 .webextrc
 .wxt
 *.log
-/.vscode/
 /docs/.vitepress/cache
 coverage
 dist
-e2e/project
 node_modules
 TODOs.md
 web-ext.config.js
 web-ext.config.ts
+templates/*/pnpm-lock.yaml
+templates/*/yarn.lock
+templates/*/package-lock.json
+docs/api/reference
+stats.html
+.tool-versions
+.cache
+*-stats.txt

.npmrc

@@ -1,2 +0,0 @@
-ignore-workspace-root-check=true
-use-node-version=18.16.0

.prettierignore

@@ -1,3 +1,8 @@
 .output
 coverage
 dist
+.wxt
+docs/.vitepress/cache
+pnpm-lock.yaml
+CHANGELOG.md
+packages/browser/src/gen

.prettierrc.yml

@@ -1,3 +1,2 @@
 singleQuote: true
-trailingComma: all
 endOfLine: lf

.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+  "recommendations": [
+    "davidanson.vscode-markdownlint",
+    "esbenp.prettier-vscode",
+    "github.vscode-github-actions"
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,14 @@
+{
+  // Set default formatter
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+
+  "[json]": { "editor.defaultFormatter": "esbenp.prettier-vscode" },
+  "[yaml]": { "editor.defaultFormatter": "esbenp.prettier-vscode" },
+  "[typescript]": { "editor.defaultFormatter": "esbenp.prettier-vscode" },
+  "[markdown]": { "editor.defaultFormatter": "esbenp.prettier-vscode" },
+
+  // Additional guidelines for Copilot
+  "github.copilot.chat.codeGeneration.instructions": [
+    { "file": "CONTRIBUTING.md" }
+  ]
+}

CHANGELOG.md

@@ -1,111 +0,0 @@
-# Changelog
-
-## v0.0.2
-
-[compare changes](https://github.com/aklinker1/wxt/compare/v0.0.1...v0.0.2)
-
-### 🚀 Enhancements
-
-- Reload extension when source code is changed ([#17](https://github.com/aklinker1/wxt/pull/17))
-- Setup background script web socket/reload ([#22](https://github.com/aklinker1/wxt/pull/22))
-- Reload HTML files individually ([#23](https://github.com/aklinker1/wxt/pull/23))
-
-### 🩹 Fixes
-
-- Output chunks to a chunks directory ([2dd7a99](https://github.com/aklinker1/wxt/commit/2dd7a99))
-- Remove hash from content script css outputs ([#20](https://github.com/aklinker1/wxt/pull/20))
-- Overwrite files with the same name when renaming entrypoints in dev mode ([37986bf](https://github.com/aklinker1/wxt/commit/37986bf))
-- Separate template builds to prevent sharing chunks ([7f3a1e8](https://github.com/aklinker1/wxt/commit/7f3a1e8))
-- Show Vite warnings and errors ([c51f0e0](https://github.com/aklinker1/wxt/commit/c51f0e0))
-
-### 📖 Documentation
-
-- Add milestone progress badge to README ([684197d](https://github.com/aklinker1/wxt/commit/684197d))
-- Fix milestone link in README ([e14f81d](https://github.com/aklinker1/wxt/commit/e14f81d))
-
-### 🏡 Chore
-
-- Update changelog ([a9af4d3](https://github.com/aklinker1/wxt/commit/a9af4d3))
-- Refactor build output type ([#19](https://github.com/aklinker1/wxt/pull/19))
-- Refactor build outputs to support transpiled templates ([a78aada](https://github.com/aklinker1/wxt/commit/a78aada))
-- Rename `templates` to `virtual-modules` ([#24](https://github.com/aklinker1/wxt/pull/24))
-- Update cli screenshot ([54eb118](https://github.com/aklinker1/wxt/commit/54eb118))
-
-### ❤️ Contributors
-
-- Aaron Klinker
-- Aaron
-
-## v0.0.1
-
-[compare changes](https://github.com/aklinker1/wxt/compare/v0.0.0...v0.0.1)
-
-### 🚀 Enhancements
-
-- Add logger to config ([232ff7a](https://github.com/aklinker1/wxt/commit/232ff7a))
-- Export and bootstrap the `/client` package ([5b07c95](https://github.com/aklinker1/wxt/commit/5b07c95))
-- Resolve entrypoints based on filesystem ([a63f061](https://github.com/aklinker1/wxt/commit/a63f061))
-- Separate output directories for each browser/manifest version ([f09ffbb](https://github.com/aklinker1/wxt/commit/f09ffbb))
-- Build entrypoints and output `manfiest.json` ([1e7c738](https://github.com/aklinker1/wxt/commit/1e7c738))
-- Automatically add CSS files to content scripts ([047ce04](https://github.com/aklinker1/wxt/commit/047ce04))
-- Download and bundle remote URL imports ([523c7df](https://github.com/aklinker1/wxt/commit/523c7df))
-- Generate type declarations and config for project types and auto-imports ([21debad](https://github.com/aklinker1/wxt/commit/21debad))
-- Good looking console output ([e2cc995](https://github.com/aklinker1/wxt/commit/e2cc995))
-- Dev server working and a valid extension is built ([505e419](https://github.com/aklinker1/wxt/commit/505e419))
-- Virtualized content script entrypoint ([ca29537](https://github.com/aklinker1/wxt/commit/ca29537))
-- Provide custom, typed globals defined by Vite ([8c59a1c](https://github.com/aklinker1/wxt/commit/8c59a1c))
-- Copy public directory to outputs ([1a25f2b](https://github.com/aklinker1/wxt/commit/1a25f2b))
-- Support browser and chrome styles for mv2 popups ([7945c94](https://github.com/aklinker1/wxt/commit/7945c94))
-- Support browser and chrome styles for mv2 popups ([7abb577](https://github.com/aklinker1/wxt/commit/7abb577))
-- Support more CLI flags for `build` and `dev` ([#9](https://github.com/aklinker1/wxt/pull/9))
-- Add more supported browser types ([f114c5b](https://github.com/aklinker1/wxt/commit/f114c5b))
-- Open browser when starting dev server ([#11](https://github.com/aklinker1/wxt/pull/11))
-
-### 🩹 Fixes
-
-- Support `srcDir` config ([739d19f](https://github.com/aklinker1/wxt/commit/739d19f))
-- Root path customization now works ([4faa3b3](https://github.com/aklinker1/wxt/commit/4faa3b3))
-- Print durations as ms/s based on total time ([3e37de9](https://github.com/aklinker1/wxt/commit/3e37de9))
-- Don't print error twice when background crashes ([407627c](https://github.com/aklinker1/wxt/commit/407627c))
-- Load package.json from root not cwd ([3ca16ee](https://github.com/aklinker1/wxt/commit/3ca16ee))
-- Only allow a single entrypoint with a given name ([8eb4e86](https://github.com/aklinker1/wxt/commit/8eb4e86))
-- Respect the mv2 popup type ([0f37ceb](https://github.com/aklinker1/wxt/commit/0f37ceb))
-- Respect background type and persistent manifest options ([573ef80](https://github.com/aklinker1/wxt/commit/573ef80))
-- Make content script array orders consistent ([f380378](https://github.com/aklinker1/wxt/commit/f380378))
-- Firefox manifest warnings in dev mode ([50bb845](https://github.com/aklinker1/wxt/commit/50bb845))
-
-### 📖 Documentation
-
-- Update README ([785ea54](https://github.com/aklinker1/wxt/commit/785ea54))
-- Update README ([99ccadb](https://github.com/aklinker1/wxt/commit/99ccadb))
-- Update description ([07a262e](https://github.com/aklinker1/wxt/commit/07a262e))
-- Update README ([58a0ef4](https://github.com/aklinker1/wxt/commit/58a0ef4))
-- Update README ([23ed6f7](https://github.com/aklinker1/wxt/commit/23ed6f7))
-- Add initial release milestone link to README ([b400e54](https://github.com/aklinker1/wxt/commit/b400e54))
-- Fix typo in README ([5590c9d](https://github.com/aklinker1/wxt/commit/5590c9d))
-
-### 🏡 Chore
-
-- Refactor cli files into their own directory ([e6c0d84](https://github.com/aklinker1/wxt/commit/e6c0d84))
-- Simplify `BuildOutput` type ([1f6c4a0](https://github.com/aklinker1/wxt/commit/1f6c4a0))
-- Move `.exvite` directory into `srcDir` instead of `root` ([53fb805](https://github.com/aklinker1/wxt/commit/53fb805))
-- Refactor CLI commands ([b8952b6](https://github.com/aklinker1/wxt/commit/b8952b6))
-- Improve build summary sorting ([ec57e8c](https://github.com/aklinker1/wxt/commit/ec57e8c))
-- Remove comments ([e3e9c0d](https://github.com/aklinker1/wxt/commit/e3e9c0d))
-- Refactor internal config creation ([7c634f4](https://github.com/aklinker1/wxt/commit/7c634f4))
-- Check virtual entrypoints feature in README ([70208f4](https://github.com/aklinker1/wxt/commit/70208f4))
-- Add E2E tests and convert to vitest workspace ([5813302](https://github.com/aklinker1/wxt/commit/5813302))
-- Rename package to wxt ([51a1072](https://github.com/aklinker1/wxt/commit/51a1072))
-- Fix header log's timestamp ([8ca5657](https://github.com/aklinker1/wxt/commit/8ca5657))
-- Fix demo global usage ([1ecfedd](https://github.com/aklinker1/wxt/commit/1ecfedd))
-- Refactor folder structure ([9ab3953](https://github.com/aklinker1/wxt/commit/9ab3953))
-- Fix release workflow ([2e94f2a](https://github.com/aklinker1/wxt/commit/2e94f2a))
-
-### 🤖 CI
-
-- Create validation workflow ([#12](https://github.com/aklinker1/wxt/pull/12))
-- Create release workflow ([#13](https://github.com/aklinker1/wxt/pull/13))
-
-### ❤️ Contributors
-
-- Aaron Klinker

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+aaronklinker1@gmail.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,186 @@
+# Contributing
+
+Everyone is welcome to contribute to **WXT**!
+
+If you are changing the docs or fixing a bug, feel free to fork and open a PR.
+
+If you want to add a new feature, please create an issue or discussion first so we can decide if the feature is inline with the vision for WXT.
+
+## Conventional Commits
+
+This project uses [Conventional Commit format](https://www.conventionalcommits.org/en/v1.0.0/) to automatically generate a changelog and better understand the changes in the project
+
+Here are some examples of conventional commit messages:
+
+- `feat: add new functionality`
+- `fix: correct typos in code`
+- `ci: add GitHub Actions for automated testing`
+
+## Conventional PR Titles
+
+The title of your pull request should follow the [conventional commit format](#conventional-commits). When a pull request is merged to the main branch, all changes are going to be squashed into a single commit. The message of this commit will be the title of the pull request. And for every release, the commit messages are used to generate the changelog.
+
+## Setup
+
+WXT uses `pnpm`, so make sure you have it installed.
+
+```sh
+corepack enable
+```
+
+Then, simply run the install command:
+
+```sh
+pnpm i
+```
+
+## Development
+
+Here are some helpful commands:
+
+```sh
+# Build WXT package
+cd packages/wxt
+pnpm build
+```
+
+```sh
+# Build WXT package, then build demo extension
+cd packages/wxt-demo
+pnpm build
+```
+
+```sh
+# Build WXT package, then start the demo extension in dev mode
+cd packages/wxt-demo
+pnpm dev
+```
+
+```sh
+# Run unit and E2E tests
+pnpm test
+```
+
+```sh
+# Start the docs website locally
+pnpm docs:dev
+```
+
+## Profiling
+
+```sh
+# Build the latest version
+pnpm --filter wxt build
+
+# CD to the demo directory
+cd packages/wxt-demo
+
+# 1. Generate a flamechart with 0x
+pnpm dlx 0x node_modules/wxt/bin/wxt.mjs build
+# 2. Inspect the process with chrome @ chrome://inspect
+pnpm node --inspect node_modules/wxt/bin/wxt.mjs build
+```
+
+## Updating Docs
+
+Documentation is written with VitePress, and is located in the `docs/` directory.
+
+The API reference is generated from JSDoc comments in the source code. If there's a typo or change you want to make in there, you'll need to update the source code instead of a file in the `docs/` directory.
+
+## Testing
+
+WXT has unit and E2E tests. When making a change or adding a feature, make sure to update the tests or add new ones, if they exist.
+
+> If they don't exist, feel free to create them, but that's a lot for a one-time contributor. A maintainer might add them to your PR though.
+
+To run tests for a specific file, add the filename at the end of the test command:
+
+```sh
+pnpm test manifest-contents
+```
+
+All test (unit and E2E) for all packages are ran together via [Vitest workspaces](https://vitest.dev/guide/#workspaces-support).
+
+If you want to manually test a change, you can modify the demo project for your test, but please don't leave those changes committed once you open a PR.
+
+## Templates
+
+Each directory inside `templates/` is it's own standalone project. Simply `cd` into the directory you're updating, install dependencies with `npm` (NOT `pnpm`), and run the relevant commands
+
+```sh
+cd templates/vue
+npm i
+npm run dev
+npm run build
+```
+
+Note that templates are hardcoded to a specific version of `wxt` from NPM, they do not use the local version. PR checks will test your PR's changes against the templates, but if you want to manually do it, update the package.json dependency:
+
+```diff
+  "devDependencies": {
+    "typescript": "^5.3.2",
+    "vite-plugin-solid": "^2.7.0",
+-   "wxt": "^0.8.0"
++   "wxt": "../.."
+  }
+```
+
+Then run `npm i` again.
+
+### Adding Templates
+
+To add a template, copy the vanilla template and give it a new name.
+
+```sh
+cp -r templates/vanilla templates/<new-template-name>
+```
+
+That's it. Once your template is merged, it will be available inside `wxt init` immediately. You don't need to release a new version of WXT to release a new template.
+
+## Releasing Updates
+
+Releases are done with GitHub actions:
+
+- Use the [Release workflow](https://github.com/wxt-dev/wxt/actions/workflows/release.yml) to release a single package in the monorepo. This automatically detects the version change with conventional commits, builds and uploads the package to NPM, and creates a GitHub release.
+- Use the [Sync Releases workflow](https://github.com/wxt-dev/wxt/actions/workflows/sync-releases.yml) to sync the GitHub releases with changes to the changelog. To change a release, update the `CHANGELOG.md` file and run the workflow. It will sync the releases of a single package in the monorepo.
+
+## Upgrading Dependencies
+
+Use [`taze`](https://www.npmjs.com/package/taze) to upgrade dependencies throughout the entire monorepo.
+
+```sh
+pnpm dlx taze -r
+```
+
+Configuration is in [`taze.config.ts`](./taze.config.ts).
+
+## Install Unreleased Versions
+
+This repo uses https://pkg.pr.new to publish versions of all it's packages for almost every commit. You can install them via:
+
+```sh
+npm i https://pkg.pr.new/[package-name]@[ref]
+```
+
+Or use one of the shorthands:
+
+```sh
+# Install the latest build of `wxt` from a PR:
+npm i https://pkg.pr.new/wxt@1283
+
+# Install the latest build of `@wxt-dev/module-react` on the `main` branch
+npm i https://pkg.pr.new/@wxt-dev/module-react@main
+
+# Install `@wxt-dev/storage` from a specific commit:
+npm i https://pkg.pr.new/@wxt-dev/module-react@426f907
+```
+
+## Blog Posts
+
+Anyone is welcome to submit a blog post on https://wxt.dev/blog!
+
+> [!NOTE]
+> Before starting on a blog post, please message Aaron on Discord or start a discussion on GitHub to get permission to write about a topic, but most topics are welcome: Major version updates, tutorials, etc.
+
+- **English only**: Blog posts should be written in English. Unfortunately, our maintainers doesn't have the bandwidth right now to translate our docs, let alone blog posts. Sorry 😓
+- **AI**: Please only use AI to translate or proof-read your blog post. Don't generate the whole thing... We don't want to publish that.

README.md

@@ -1,41 +1,95 @@
-<h1 align="center">WXT</h1>
+<h1 align="center">
+  <img align="top" width="44" src="https://raw.githubusercontent.com/wxt-dev/wxt/HEAD/docs/public/hero-logo.svg" alt="WXT Logo">
+  <span>WXT</span>
+</h1>
 
-<p align="center"><i>Next gen framework for developing web extensions.<br/>Powered by <a href="https://vitejs.dev/" target="_blank">Vite</a>. Inspired by <a href="https://nuxt.com/" target="_blank">Nuxt</a>.</i></p>
+<p align="center">
+  <a href="https://www.npmjs.com/package/wxt" target="_blank"><img alt="npm version" src="https://img.shields.io/npm/v/wxt?labelColor=black&color=%234fa048"></a>
+  <span> </span>
+  <a href="https://www.npmjs.com/package/wxt" target="_blank"><img alt="downloads" src="https://img.shields.io/npm/dm/wxt?labelColor=black&color=%234fa048"></a>
+  <span> </span>
+  <a href="https://github.com/wxt-dev/wxt/blob/main/LICENSE" target="_blank"><img alt="license | MIT" src="https://img.shields.io/npm/l/wxt?labelColor=black&color=%234fa048"></a>
+  <span> </span>
+  <a href="https://codecov.io/github/wxt-dev/wxt" target="_blank"><img alt="coverage" src="https://img.shields.io/codecov/c/github/wxt-dev/wxt?labelColor=black&color=%234fa048"></a>
+</p>
 
-![Example CLI Output](./.github/assets/cli-output.png)
+<p align="center">
+  <span>Next-gen framework for developing web extensions.</span>
+  <br/>
+  <span>⚡</span>
+  <br/>
+  <q><i>It's like Nuxt, but for Web Extensions</i></q>
+</p>
 
-> **Warning**
->
-> [![GitHub milestone](https://img.shields.io/github/milestones/progress-percent/aklinker1/wxt/1)](https://github.com/aklinker1/wxt/milestone/1)
->
-> WXT is not ready for use yet. Production builds work, but dev mode is incomplete.
->
-> See the [Initial Release Candidate](https://github.com/aklinker1/wxt/milestone/1) milestone for more details.
+<p align="center">
+  <a href="https://wxt.dev/guide/installation.html" target="_blank">Get Started</a>
+  &bull;
+  <a href="https://wxt.dev/api/config.html" target="_blank">Configuration</a>
+  &bull;
+  <a href="https://wxt.dev/examples.html" target="_blank">Examples</a>
+  &bull;
+  <a href="https://github.com/wxt-dev/wxt/blob/main/packages/wxt/CHANGELOG.md" target="_blank">Changelog</a>
+  &bull;
+  <a href="https://discord.gg/ZFsZqGery9" target="_blank">Discord</a>
+</p>
+
+![Example CLI Output](https://raw.githubusercontent.com/wxt-dev/wxt/HEAD/docs/assets/cli-output.png)
+
+## Demo
+
+https://github.com/wxt-dev/wxt/assets/10101283/4d678939-1bdb-495c-9c36-3aa281d84c94
+
+## Quick Start
+
+Bootstrap a new project:
+
+<!-- automd:pm-x version="latest" name="wxt" args="init" -->
+
+```sh
+# npm
+npx wxt@latest init
+
+# pnpm
+pnpm dlx wxt@latest init
+
+# bun
+bunx wxt@latest init
+```
+
+<!-- /automd -->
+
+Or see the [installation guide](https://wxt.dev/guide/installation.html) to get started with WXT.
 
 ## Features
 
 - 🌐 Supports all browsers
 - ✅ Supports both MV2 and MV3
-- 📂 Directory based entrypoints
+- ⚡ Dev mode with HMR & fast reload
+- 📂 File based entrypoints
 - 🚔 TypeScript
 - 🦾 Auto-imports
-- ⚡ Dev mode with HMR
-- ⬇️ Download and bundle remote URL imports
-- 🎨 Frontend framework agnostic: works with Vue, React, Svelte, etc
-
-### Todo
-
 - 🤖 Automated publishing
+- 🎨 Frontend framework agnostic: works with Vue, React, Svelte, etc
+- 📦 [Module system](https://wxt.dev/guide/essentials/wxt-modules.html#overview) for reusing code between extensions
 - 🖍️ Quickly bootstrap a new project
 - 📏 Bundle analysis
-- ⚡ Dev mode with HMR and **_auto-reload_**
+- ⬇️ Download and bundle remote URL imports
 
-## Get Started
+## Sponsors
 
-Checkout the [installation guide](https://wxtjs.dev/get-started) to get started with WXT.
+WXT is a [MIT-licensed](https://github.com/wxt-dev/wxt/blob/main/LICENSE) open source project with its ongoing development made possible entirely by the support of these awesome backers. If you'd like to join them, please consider [sponsoring WXT's development](https://github.com/sponsors/wxt-dev).
+
+<a href="https://github.com/sponsors/wxt-dev"><img alt="WXT Sponsors" src="https://raw.githubusercontent.com/wxt-dev/static/refs/heads/main/sponsorkit/sponsors.svg"></a>
 
 ## Contributors
 
-<a href="https://github.com/aklinker1/wxt/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=aklinker1/wxt" />
+<!-- automd:contributors author="aklinker1" license="MIT" github="wxt-dev/wxt" -->
+
+Published under the [MIT](https://github.com/wxt-dev/wxt/blob/main/LICENSE) license.
+Made by [@aklinker1](https://github.com/aklinker1) and [community](https://github.com/wxt-dev/wxt/graphs/contributors) 💛
+<br><br>
+<a href="https://github.com/wxt-dev/wxt/graphs/contributors">
+<img src="https://contrib.rocks/image?repo=wxt-dev/wxt" />
 </a>
+
+<!-- /automd -->

SECURITY.md

@@ -0,0 +1,15 @@
+# Security Policy
+
+While WXT is in prerelease, only the latest version will receive security updates. The latest version is:
+
+<img alt="npm version" src="https://img.shields.io/npm/v/wxt?labelColor=black&color=%234fa048">
+
+<!--
+## Reporting a Vulnerability
+
+Use this section to tell people how to report a vulnerability.
+
+Tell them where to go, how often they can expect to get an update on a
+reported vulnerability, what to expect if the vulnerability is accepted or
+declined, etc.
+-->

demo/package.json

@@ -1,23 +0,0 @@
-{
-  "name": "Demo",
-  "version": "1.0.0",
-  "description": "Demo extension for WXT",
-  "type": "module",
-  "scripts": {
-    "dev": "pnpm -w build && wxt",
-    "build": "pnpm -w build && wxt build",
-    "build:all": "pnpm -w build && run-s -s build:all:*",
-    "build:all:chrome-mv3": "wxt build",
-    "build:all:chrome-mv2": "wxt build --mv2",
-    "build:all:firefox-mv3": "wxt build -b firefox --mv3",
-    "build:all:firefox-mv2": "wxt build -b firefox",
-    "prepare": "pnpm -w build && wxt prepare"
-  },
-  "dependencies": {
-    "webextension-polyfill": "^0.10.0"
-  },
-  "devDependencies": {
-    "@types/webextension-polyfill": "^0.10.0",
-    "wxt": "workspace:*"
-  }
-}

demo/src/common/style.css

@@ -1,4 +0,0 @@
-body {
-  margin: 0;
-  padding: 0;
-}

demo/src/entrypoints/background.ts

@@ -1,10 +0,0 @@
-export default defineBackgroundScript(() => {
-  console.log(browser.runtime.id);
-  logId();
-  console.log({
-    browser: __BROWSER__,
-    chrome: __IS_CHROME__,
-    firefox: __IS_FIREFOX__,
-    manifestVersion: __MANIFEST_VERSION__,
-  });
-});

demo/src/entrypoints/options/main.ts

@@ -1,5 +0,0 @@
-import 'url:https://stats.aklinker1.io/umami.js';
-
-console.log(browser.runtime.id);
-logId();
-console.log(2);

demo/tsconfig.json

@@ -1,3 +0,0 @@
-{
-  "extends": ["../tsconfig.base.json", "./src/.wxt/tsconfig.json"]
-}

demo/wxt.config.ts

@@ -1,17 +0,0 @@
-import { defineConfig } from 'wxt';
-
-export default defineConfig({
-  srcDir: 'src',
-  storeIds: {
-    chrome: '123',
-  },
-  manifest: {
-    icons: {
-      '16': 'icon/16.png',
-      '32': 'icon/32.png',
-      '48': 'icon/48.png',
-      '96': 'icon/96.png',
-      '128': 'icon/128.png',
-    },
-  },
-});

docs/.vitepress/Dockerfile

@@ -0,0 +1,2 @@
+FROM lipanski/docker-static-website:latest
+COPY dist .

docs/.vitepress/components/BlogHome.vue

@@ -0,0 +1,70 @@
+<script lang="ts" setup>
+import { computed } from 'vue';
+// @ts-expect-error: Vitepress data-loader magic, this import is correct
+import { data } from '../loaders/blog.data';
+import BlogPostPreview from './BlogPostPreview.vue';
+
+const posts = computed(() =>
+  data
+    .map((post) => ({
+      ...post,
+      ...post.frontmatter,
+      date: new Date(post.frontmatter.date),
+    }))
+    .sort((a, b) => b.date.getTime() - a.date.getTime()),
+);
+</script>
+
+<template>
+  <div class="container">
+    <div>
+      <div class="vp-doc">
+        <h1>Blog</h1>
+      </div>
+
+      <ul>
+        <BlogPostPreview v-for="post of posts" :key="post.url" :post />
+      </ul>
+    </div>
+  </div>
+</template>
+
+<style scoped>
+.container {
+  display: flex;
+  flex-direction: column;
+  align-items: center;
+}
+.container > div {
+  padding: 32px;
+  max-width: 900px;
+  width: 100%;
+  min-width: 0;
+}
+
+h1 {
+  padding-bottom: 16px;
+}
+
+ul {
+  display: flex;
+  flex-direction: column;
+  list-style: none;
+}
+ul,
+li {
+  padding: 0;
+  margin: 0;
+}
+
+ul li {
+  padding-top: 16px;
+  margin-top: 16px;
+  border-top: 1px solid var(--vp-c-default);
+}
+ul li:last-child {
+  padding-bottom: 16px;
+  margin-bottom: 16px;
+  border-bottom: 1px solid var(--vp-c-default);
+}
+</style>

docs/.vitepress/components/BlogLayout.vue

@@ -0,0 +1,76 @@
+<script lang="ts" setup>
+import useBlogDate from '../composables/useBlogDate';
+import { useData } from 'vitepress';
+
+const { frontmatter } = useData();
+const date = useBlogDate(() => frontmatter.value.date);
+</script>
+
+<template>
+  <div class="vp-doc">
+    <main class="container-content">
+      <h1 v-html="$frontmatter.title" />
+      <p class="meta-row">
+        <a
+          class="author"
+          v-for="author of $frontmatter.authors"
+          :key="author.github"
+          :href="`https://github.com/${author.github}`"
+        >
+          <img :src="`https://github.com/${author.github}.png?size=96`" />
+          <span>{{ author.name }}</span>
+        </a>
+        <span>&bull;</span>
+        <span>{{ date }}</span>
+      </p>
+      <Content />
+    </main>
+  </div>
+</template>
+
+<style scoped>
+vp-doc {
+  display: flex;
+}
+main {
+  max-width: 1080px;
+  padding: 32px;
+  margin: auto;
+}
+@media (min-width: 768px) {
+  main {
+    padding: 64px;
+  }
+}
+.meta-row {
+  display: flex;
+  color: var(--vp-c-text-2);
+  gap: 16px;
+  overflow: hidden;
+  padding-bottom: 32px;
+}
+.meta-row > * {
+  flex-shrink: 0;
+}
+.author {
+  display: flex;
+  gap: 8px;
+  align-items: center;
+  color: var(--vp-c-text-2);
+  font-weight: normal;
+  text-decoration: none;
+}
+.author img {
+  width: 24px;
+  height: 24px;
+  border-radius: 100%;
+}
+.author span {
+  padding: 0;
+  margin: 0;
+}
+.author:hover {
+  text-decoration: underline;
+  color: var(--vp-c-text-2);
+}
+</style>

docs/.vitepress/components/BlogPostPreview.vue

@@ -0,0 +1,72 @@
+<script lang="ts" setup>
+import useBlogDate from '../composables/useBlogDate';
+
+const props = defineProps<{
+  post: {
+    title: string;
+    description?: string;
+    date: Date;
+    url: string;
+    authors: Array<{ name: string; github: string }>;
+  };
+}>();
+
+const date = useBlogDate(() => props.post.date);
+</script>
+
+<template>
+  <li class="blog-list-item">
+    <a :href="post.url">
+      <div class="vp-doc">
+        <h3 class="title" v-html="post.title" />
+        <p class="description" v-html="post.description" />
+        <p class="meta">
+          {{ post.authors.map((author) => author.name).join(', ') }}
+          &bull;
+          {{ date }}
+        </p>
+      </div>
+    </a>
+  </li>
+</template>
+
+<style scoped>
+li {
+  padding: 0;
+  margin: 0;
+}
+
+p {
+  margin: 0;
+}
+h3 {
+  margin: 0;
+  padding: 0;
+  border: none;
+}
+
+li > a > div {
+  display: flex;
+  flex-direction: column;
+  margin: 0 -16px;
+  padding: 16px;
+  border-radius: 16px;
+}
+li > a > div:hover {
+  background: var(--vp-c-default);
+}
+li .title {
+  color: var(--vp-c-text);
+  margin-bottom: 12px;
+}
+li .description {
+  font-size: 16px;
+  color: var(--vp-c-text-2);
+  margin-bottom: 8px;
+}
+li .meta {
+  font-weight: 400;
+  font-size: 12px;
+  color: var(--vp-c-text-2);
+}
+</style>

docs/.vitepress/components/EntrypointPatterns.vue

@@ -0,0 +1,40 @@
+<script lang="ts" setup>
+const props = defineProps<{
+  patterns: Array<[intput: string, output: string]>;
+}>();
+</script>
+
+<template>
+  <table class="no-vertical-dividers">
+    <thead>
+      <tr>
+        <th style="width: 100%">Filename</th>
+        <th></th>
+        <th>Output Path</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr v-for="pattern of patterns">
+        <td style="white-space: nowrap; padding-right: 8px">
+          <code>entrypoints/{{ pattern[0] }}</code>
+        </td>
+        <td style="padding: 6px; opacity: 50%">
+          <svg
+            xmlns="http://www.w3.org/2000/svg"
+            width="20"
+            height="20"
+            viewBox="0 0 24 24"
+          >
+            <path
+              fill="currentColor"
+              d="M4 11v2h12l-5.5 5.5l1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5L16 11H4Z"
+            />
+          </svg>
+        </td>
+        <td style="white-space: nowrap; padding-left: 8px">
+          <code>/{{ pattern[1] }}</code>
+        </td>
+      </tr>
+    </tbody>
+  </table>
+</template>

docs/.vitepress/components/ExampleSearch.vue

@@ -0,0 +1,226 @@
+<script lang="ts" setup>
+import { ref, onMounted, computed, toRaw, Ref } from 'vue';
+import ExampleSearchFilterByItem from './ExampleSearchFilterByItem.vue';
+import ExampleSearchResult from './ExampleSearchResult.vue';
+import { ExamplesMetadata, KeySelectedObject } from '../utils/types';
+
+const props = defineProps<{
+  tag?: string;
+}>();
+
+const exampleMetadata = ref<ExamplesMetadata>();
+onMounted(async () => {
+  const res = await fetch(
+    'https://raw.githubusercontent.com/wxt-dev/examples/main/metadata.json',
+  );
+  exampleMetadata.value = await res.json();
+});
+
+const searchText = ref('');
+const selectedApis = ref<KeySelectedObject>({});
+const selectedPermissions = ref<KeySelectedObject>({});
+const selectedPackages = ref<KeySelectedObject>({});
+
+function useRequiredItems(selectedItems: Ref<KeySelectedObject>) {
+  return computed(() =>
+    Array.from(
+      Object.entries(toRaw(selectedItems.value)).reduce(
+        (set, [pkg, checked]) => {
+          if (checked) set.add(pkg);
+          return set;
+        },
+        new Set<string>(),
+      ),
+    ),
+  );
+}
+const requiredApis = useRequiredItems(selectedApis);
+const requiredPermissions = useRequiredItems(selectedPermissions);
+const requiredPackages = useRequiredItems(selectedPackages);
+
+function doesExampleMatchSelected(
+  exampleItems: string[],
+  requiredItems: Ref<string[]>,
+) {
+  const exampleItemsSet = new Set(exampleItems);
+  return !requiredItems.value.find((item) => !exampleItemsSet.has(item));
+}
+
+const filteredExamples = computed(() => {
+  const text = searchText.value.toLowerCase();
+  return exampleMetadata.value.examples.filter((example) => {
+    const matchesText = example.searchText.toLowerCase().includes(text);
+    const matchesApis = doesExampleMatchSelected(example.apis, requiredApis);
+    const matchesPermissions = doesExampleMatchSelected(
+      example.permissions,
+      requiredPermissions,
+    );
+    const matchesPackages = doesExampleMatchSelected(
+      example.packages,
+      requiredPackages,
+    );
+    return matchesText && matchesApis && matchesPermissions && matchesPackages;
+  });
+});
+</script>
+
+<template>
+  <div class="example-layout">
+    <div class="search">
+      <input v-model="searchText" placeholder="Search for an example..." />
+    </div>
+
+    <div class="filters">
+      <ExampleSearchFilterByItem
+        label="APIs"
+        :items="exampleMetadata?.allApis"
+        v-model="selectedApis"
+      />
+      <ExampleSearchFilterByItem
+        label="Permissions"
+        :items="exampleMetadata?.allPermissions"
+        v-model="selectedPermissions"
+      />
+      <ExampleSearchFilterByItem
+        label="Packages"
+        :items="exampleMetadata?.allPackages"
+        v-model="selectedPackages"
+      />
+    </div>
+
+    <div class="results">
+      <p v-if="exampleMetadata == null">Loading examples...</p>
+      <template v-else>
+        <ul class="search-results">
+          <ExampleSearchResult
+            v-for="example of filteredExamples"
+            :key="example.name"
+            :example
+          />
+        </ul>
+        <p v-if="filteredExamples.length === 0">No matching examples</p>
+      </template>
+    </div>
+  </div>
+</template>
+
+<style scoped>
+.example-layout {
+  display: grid;
+  grid-template-columns: 1fr;
+  grid-template-rows: 1fr;
+  grid-template-areas:
+    'search'
+    'results';
+  gap: 16px;
+}
+@media only screen and (min-width: 720px) {
+  .example-layout {
+    grid-template-columns: 256px 1fr;
+    grid-template-rows: auto 1fr;
+    grid-template-areas:
+      'filters search'
+      'filters results';
+  }
+}
+.search {
+  grid-area: search;
+  background: var(--vp-c-bg-soft);
+  padding: 20px;
+  width: 100%;
+  display: flex;
+  border-radius: 16px;
+}
+.filters {
+  display: none;
+  grid-area: filters;
+}
+@media only screen and (min-width: 720px) {
+  .filters {
+    display: flex;
+    flex-direction: column;
+    gap: 2px;
+    border-radius: 16px;
+    overflow: hidden;
+    align-self: flex-start;
+  }
+}
+.results {
+  grid-area: results;
+}
+
+.box {
+  border-radius: 16px;
+  overflow: hidden;
+}
+
+.search input {
+  min-width: 0;
+  flex: 1;
+  font-size: 16px;
+}
+
+.checkbox-col {
+  flex: 1;
+  padding: 16px;
+  display: flex;
+  flex-direction: column;
+  overflow-y: auto;
+  max-height: 200px;
+  font-size: 14px;
+  gap: 4px;
+}
+
+.filter-btn {
+  color: var(--vp-c-brand-1);
+}
+
+.checkbox-col .header {
+  font-size: 12px;
+  font-weight: bold;
+  opacity: 50%;
+}
+
+.checkbox-col p {
+  display: flex;
+  gap: 4px;
+  align-items: flex-start;
+  text-wrap: wrap;
+  overflow-wrap: anywhere;
+  line-height: 140%;
+}
+
+span {
+  padding-top: 1px;
+}
+
+.checkbox-col input[type='checkbox'] {
+  width: 16px;
+  height: 16px;
+  flex-shrink: 0;
+}
+
+.checkbox-col-container {
+  display: flex;
+}
+
+.search-results {
+  display: grid;
+  grid-template-columns: repeat(1, 1fr);
+  gap: 16px;
+}
+@media only screen and (min-width: 800px) {
+  .search-results {
+    grid-template-columns: repeat(2, 1fr);
+  }
+}
+@media only screen and (min-width: 1024px) {
+  .search-results {
+    grid-template-columns: repeat(3, 1fr);
+  }
+}
+
+a {
+  background-color: red;
+}
+</style>

docs/.vitepress/components/ExampleSearchFilterByItem.vue

@@ -0,0 +1,100 @@
+<script lang="ts" setup>
+import { computed, toRaw } from 'vue';
+import { KeySelectedObject } from '../utils/types';
+
+const props = defineProps<{
+  label: string;
+  items?: string[];
+}>();
+
+const selectedItems = defineModel<KeySelectedObject>({
+  required: true,
+});
+
+const count = computed(() => {
+  return Object.values(toRaw(selectedItems.value)).filter(Boolean).length;
+});
+
+function toggleItem(pkg: string) {
+  selectedItems.value = {
+    ...toRaw(selectedItems.value),
+    [pkg]: !selectedItems.value[pkg],
+  };
+}
+</script>
+
+<template>
+  <div class="filter-container">
+    <p class="header">
+      <span>Filter by {{ label }}</span> <span v-if="count">({{ count }})</span>
+    </p>
+    <div class="scroll-container">
+      <ul>
+        <li v-for="item in items">
+          <label :title="item">
+            <input
+              type="checkbox"
+              :checked="selectedItems[item]"
+              @input="toggleItem(item)"
+            />
+            <span>{{ item }}</span>
+          </label>
+        </li>
+      </ul>
+    </div>
+  </div>
+</template>
+
+<style scoped>
+.filter-container {
+  height: 300px;
+  display: flex;
+  flex-direction: column;
+  background: var(--vp-c-bg-soft);
+}
+
+.scroll-container {
+  flex: 1;
+  overflow: hidden;
+  position: relative;
+}
+
+.scroll-container ul {
+  position: absolute;
+  overflow-y: auto;
+  left: 0;
+  top: 0;
+  right: 0;
+  bottom: 0;
+  display: flex;
+  flex-direction: column;
+  gap: 4px;
+  font-size: small;
+  padding: 8px 16px 16px 16px;
+}
+
+.header {
+  padding: 8px 16px;
+  font-size: 12px;
+  font-weight: bold;
+  opacity: 50%;
+}
+label {
+  display: flex;
+  gap: 4px;
+  align-items: flex-start;
+  text-wrap: wrap;
+  overflow-wrap: anywhere;
+  line-height: 140%;
+  cursor: pointer;
+  text-wrap: nowrap;
+}
+span {
+  padding-top: 1px;
+}
+input[type='checkbox'] {
+  width: 16px;
+  height: 16px;
+  flex-shrink: 0;
+}
+</style>

docs/.vitepress/components/ExampleSearchResult.vue

@@ -0,0 +1,72 @@
+<script lang="ts" setup>
+import { Example } from '../utils/types';
+
+const props = defineProps<{
+  example: Example;
+}>();
+</script>
+
+<template>
+  <li>
+    <a :href="example.url" target="_blank">
+      <p class="name">{{ example.name }}</p>
+      <p class="description">{{ example.description }}</p>
+      <p class="link">Open &rarr;</p>
+    </a>
+  </li>
+</template>
+
+<style scoped>
+* {
+  min-width: 0;
+}
+a {
+  padding: 16px;
+  display: flex;
+  flex-direction: column;
+  border: 2px solid var(--vp-c-bg-soft);
+  border-radius: 16px;
+  color: var(--vp-c-text-1) !important;
+  gap: 8px;
+}
+
+a:hover {
+  outline: 2px solid var(--vp-c-brand-2);
+}
+.name {
+  font-size: 16px;
+  font-weight: 500;
+  white-space: nowrap;
+  overflow: hidden;
+  text-overflow: ellipsis;
+  flex-shrink: 0;
+
+  text-overflow: ellipsis;
+  overflow: hidden;
+  white-space: nowrap;
+}
+.description {
+  height: 53px;
+  opacity: 70%;
+  font-size: 14px;
+  font-weight: normal;
+  line-height: 120%;
+  min-height: 0;
+
+  display: -webkit-box;
+  -webkit-line-clamp: 3;
+  -webkit-box-orient: vertical;
+  overflow: hidden;
+}
+
+.link {
+  opacity: 0;
+  transition: 250ms;
+  color: var(--vp-c-brand-2);
+  font-weight: bold;
+  text-align: right;
+}
+a:hover .link {
+  opacity: 100%;
+}
+</style>

docs/.vitepress/components/Icon.vue

@@ -0,0 +1,26 @@
+<script lang="ts" setup>
+import { computed } from 'vue';
+
+const props = defineProps<{
+  name: string;
+  icon?: string;
+}>();
+
+const src = computed(() => {
+  if (props.icon) return props.icon;
+  return `https://raw.githubusercontent.com/PKief/vscode-material-icon-theme/main/icons/${props.name.toLowerCase()}.svg`;
+});
+</script>
+
+<template>
+  <img :src="src" :alt="`${name} Logo`" />
+</template>
+
+<style scoped>
+img {
+  display: inline;
+  transform: translateY(5px);
+  margin-right: 8px;
+  width: 20px;
+}
+</style>

docs/.vitepress/components/UsingWxtSection.vue

@@ -0,0 +1,238 @@
+<script lang="ts" setup>
+import { computed } from 'vue';
+import useListExtensionDetails, {
+  ChromeExtension,
+} from '../composables/useListExtensionDetails';
+
+// Add extension IDs here. Order doesn't matter, will be sorted by a combination of weekly active users and rating.
+// Change the commit message or PR title to: "docs: Added "[extension name]" to the homepage"
+const chromeExtensionIds = [
+  'ocfdgncpifmegplaglcnglhioflaimkd', // GitHub: Better Line Counts
+  'mgmdkjcljneegjfajchedjpdhbadklcf', // Anime Skip Player
+  'bfbnagnphiehemkdgmmficmjfddgfhpl', // UltraWideo
+  'elfaihghhjjoknimpccccmkioofjjfkf', // StayFree - Website Blocker & Web Analytics
+  'okifoaikfmpfcamplcfjkpdnhfodpkil', // Doozy: Ai Made Easy
+  'lknmjhcajhfbbglglccadlfdjbaiifig', // tl;dv - Record, Transcribe & ChatGPT for Google Meet
+  'oglffgiaiekgeicdgkdlnlkhliajdlja', // Youtube中文配音
+  'agjnjboanicjcpenljmaaigopkgdnihi', // PreMiD
+  'aiakblgmlabokilgljkglggnpflljdgp', // Markdown Sticky Notes
+  'nomnkbngkijpffepcgbbofhcnafpkiep', // DocVersionRedirector
+  'ceicccfeikoipigeghddpocceifjelph', // Plex Skipper
+  'aelkipgppclpfimeamgmlonimflbhlgf', // GitHub Custom Notifier
+  'djnlaiohfaaifbibleebjggkghlmcpcj', // Fluent Read
+  'nhclljcpfmmaiojbhhnkpjcfmacfcian', // Facebook Video Controls
+  'mblkhbaakhbhiimkbcnmeciblfhmafna', // ElemSnap - Quick capture of webpage elements and conversion to images,
+  'oajalfneblkfiejoadecnmodfpnaeblh', // MS Edge TTS (Text to Speech)
+  'nedcanggplmbbgmlpcjiafgjcpdimpea', // YTBlock - Block any content from YouTube™
+  'oadbjpccljkplmhnjekgjamejnbadlne', // demo.fun - Interactive product demos that convert
+  'iopdafdcollfgaoffingmahpffckmjni', // SmartEReply: Elevate Your LinkedIn™ Engagement with AI 🚀📈
+  'khjdmjcmpolknpccmaaipmidphjokhdf', // WorkFlowy MultiFlow
+  'fencadnndhdeggodopebjgdfdlhcimfk', // 香草布丁🌿🍮- https://github.com/Xdy1579883916/vanilla-pudding
+  'bnacincmbaknlbegecpioobkfgejlojp', // MaxFocus: Link Preview
+  'bcpgdpedphodjcjlminjbdeejccjbimp', // 汇率转换-中文版本
+  'loeilaonggnalkaiiaepbegccilkmjjp', // Currency Converter Plus
+  'npcnninnjghigjfiecefheeibomjpkak', // Respond Easy
+  'cfkdcideecefncbglkhneoflfnmhoicc', // mindful - stay focused on your goals
+  'lnhejcpclabmbgpiiomjbhalblnnbffg', // 1Proompt
+  'fonflmjnjbkigocpoommgmhljdpljain', // NiceTab - https://github.com/web-dahuyou/NiceTab
+  'fcffekbnfcfdemeekijbbmgmkognnmkd', // Draftly for LinkedIn
+  'nkndldfehcidpejfkokbeghpnlbppdmo', // YouTube Summarized - Summarize any YouTube video
+  'dbichmdlbjdeplpkhcejgkakobjbjalc', // 社媒助手 - https://github.com/iszhouhua/social-media-copilot
+  'opepfpjeogkbgeigkbepobceinnfmjdd', // Dofollow Links for SEO
+  'pdnenlnelpdomajfejgapbdpmjkfpjkp', // ChatGPT Writer: Use AI on Any Site (GPT-4o, Claude, Gemini, and More)
+  'jobnhifpphkgoelnhnopgkdhbdkiadmj', // discord message translator
+  'ncokhechhpjgjonhjnlaneglmdkfkcbj', // Habit Tracker app widget for daily habit tracking
+  'lnjaiaapbakfhlbjenjkhffcdpoompki', // Catppuccin for GitHub File Explorer Icons
+  'cpaedhbidlpnbdfegakhiamfpndhjpgf', // WebChat: Chat with anyone on any website
+  'fcphghnknhkimeagdglkljinmpbagone', // YouTube Auto HD + FPS
+  'lpomjgbicdemjkgmbnkjncgdebogkhlb', // MultiViewer Companion
+  'ggiafipgeeaaahnjamgpjcgkdpanhddg', // Sync Watch - Watch videos together on any site
+  'nmldnjcblcihmegipecakhmnieiofmgl', // Keyword Rank Checker
+  'gppllamhaciichleihemgilcpledblpn', // YouTube Simple View - Hide distractions & more
+  'pccbghdfdnnkkbcdcibchpbffdgednkf', // Propbar - Property Data Enhancer
+  'lfknakglefggmdkjdfhhofkjnnolffkh', // Text Search Pro - Search by case and whole-word match!
+  'mbenhbocjckkbaojacmaepiameldglij', // Invoice Generator
+  'phlfhkmdofajnbhgmbmjkbkdgppgoppb', // Monthly Bill Tracker
+  'macmkmchfoclhpbncclinhjflmdkaoom', // Wandpen - Instantly improve your writing with AI
+  'lhmgechokhmdekdpgkkemoeecelcaonm', // YouTube Hider - Remove Comments By Keywords, Usernames & Tools
+  'imgheieooppmahcgniieddodaliodeeg', // QA Compass - Record standardized bug reports easily
+  'npgghjedpchajflknnbngajkjkdhncdo', // aesthetic Notion, styled
+  'hmdcmlfkchdmnmnmheododdhjedfccka', // Eye Dropper
+  'eihpmapodnppeemkhkbhikmggfojdkjd', // Cursorful - Screen Recorder with Auto Zoom
+  'hjjkgbibknbahijglkffklflidncplkn', // Show IP – Live View of Website IPs for Developers
+  'ilbikcehnpkmldojkcmlldkoelofnbde', // Strong Password Generator
+  'ocllfkhcdopiafndigclebelbecaiocp', // ZenGram: Mindful Instagram, Your Way
+  'odffpjnpocjfcaclnenaaaddghkgijdb', // Blync: Preview Links, Selection Search, AI Assistant
+  'kofbbilhmnkcmibjbioafflgmpkbnmme', // HTML to Markdown - Convert webpages to markdown
+  'boecmgggeigllcdocgioijmleimjbfkg', // Walmart WFS Profit Calculator
+  'dlnjcbkmomenmieechnmgglgcljhoepd', // Youtube Live Chat Fullscreen
+  'keiealdacakpnbbljlmhfgcebmaadieg', // Python Code Runner
+  'hafcajcllbjnoolpfngclfmmgpikdhlm', // Monochromate
+  'bmoggiinmnodjphdjnmpcnlleamkfedj', // AliasVault - Open-Source Password & (Email) Alias Manager
+  'hlnhhamckimoaiekbglafiebkfimhapb', // SnapThePrice: AI-Powered Real-time Lowest Price Finder
+];
+
+const { data, err, isLoading } = useListExtensionDetails(chromeExtensionIds);
+const sortedExtensions = computed(() => {
+  if (!data.value?.length) return [];
+
+  return [...data.value]
+    .filter((item) => item != null)
+    .map((item) => ({
+      ...item,
+      // Sort based on the user count weighted by the rating
+      sortKey: ((item.rating ?? 5) / 5) * item.weeklyActiveUsers,
+    }))
+    .filter((item) => !!item)
+    .sort((l, r) => r.sortKey - l.sortKey);
+});
+
+function getStoreUrl(extension: ChromeExtension) {
+  const url = new URL(extension.storeUrl);
+  url.searchParams.set('utm_source', 'wxt.dev');
+  return url.href;
+}
+</script>
+
+<template>
+  <p v-if="isLoading" style="text-align: center; opacity: 50%">Loading...</p>
+  <p
+    v-else-if="err || sortedExtensions.length === 0"
+    style="text-align: center; opacity: 50%"
+  >
+    Failed to load extension details.
+  </p>
+  <ul v-else>
+    <li
+      v-for="extension of sortedExtensions"
+      :key="extension.id"
+      class="relative"
+    >
+      <img
+        :src="extension.iconUrl"
+        :alt="`${extension.name} icon`"
+        referrerpolicy="no-referrer"
+      />
+      <div class="relative">
+        <a
+          :href="getStoreUrl(extension)"
+          target="_blank"
+          :title="extension.name"
+          class="extension-name"
+          >{{ extension.name }}</a
+        >
+        <p class="description" :title="extension.shortDescription">
+          {{ extension.shortDescription }}
+        </p>
+      </div>
+      <p class="user-count">
+        <span>{{ extension.weeklyActiveUsers.toLocaleString() }} users</span
+        ><template v-if="extension.rating != null"
+          >,
+          <span>{{ extension.rating }} stars</span>
+        </template>
+      </p>
+    </li>
+  </ul>
+  <p class="centered pr">
+    <a
+      href="https://github.com/wxt-dev/wxt/edit/main/docs/.vitepress/components/UsingWxtSection.vue"
+      target="_blank"
+      >Open a PR</a
+    >
+    to add your extension to the list!
+  </p>
+</template>
+
+<style scoped>
+li img {
+  width: 116px;
+  height: 116px;
+  padding: 16px;
+  border-radius: 8px;
+  background-color: var(--vp-c-default-soft);
+}
+
+ul {
+  display: grid;
+  grid-template-columns: repeat(1, 1fr);
+  align-items: stretch;
+  gap: 16px;
+  list-style: none;
+  margin: 16px 0;
+  padding: 0;
+}
+@media (min-width: 960px) {
+  ul {
+    grid-template-columns: repeat(2, 1fr);
+  }
+}
+
+li {
+  margin: 0 !important;
+  padding: 16px;
+  display: flex;
+  background-color: var(--vp-c-bg-soft);
+  border-radius: 12px;
+  flex: 1;
+  gap: 24px;
+  align-items: center;
+}
+
+.centered {
+  text-align: center;
+}
+
+li a,
+li .user-count,
+li .description {
+  padding: 0;
+  margin: 0;
+}
+li .user-count {
+  opacity: 70%;
+  font-size: small;
+  position: absolute;
+  bottom: 12px;
+  right: 16px;
+}
+
+li a {
+  display: -webkit-box;
+  -webkit-line-clamp: 1;
+  -webkit-box-orient: vertical;
+  overflow: hidden;
+  cursor: pointer;
+  padding: 0;
+  margin: 0;
+  text-decoration: none;
+}
+li a:hover {
+  text-decoration: underline;
+}
+
+li div {
+  flex: 1;
+}
+
+li .description {
+  opacity: 90%;
+  display: -webkit-box;
+  -webkit-line-clamp: 2;
+  -webkit-box-orient: vertical;
+  overflow: hidden;
+  margin-bottom: 16px;
+}
+
+li .extension-name {
+  font-size: large;
+}
+
+.pr {
+  opacity: 70%;
+}
+
+.relative {
+  position: relative;
+}
+</style>

docs/.vitepress/composables/useBlogDate.ts

@@ -0,0 +1,15 @@
+import { computed, toValue, MaybeRefOrGetter } from 'vue';
+
+const MONTH_FORMATTER = new Intl.DateTimeFormat(
+  globalThis?.navigator?.language,
+  {
+    month: 'long',
+  },
+);
+
+export default function (date: MaybeRefOrGetter<Date | string>) {
+  return computed(() => {
+    const d = new Date(toValue(date));
+    return `${MONTH_FORMATTER.format(d)} ${d.getDate()}, ${d.getFullYear()}`;
+  });
+}

docs/.vitepress/composables/useListExtensionDetails.ts

@@ -0,0 +1,59 @@
+import { ref } from 'vue';
+
+export interface ChromeExtension {
+  id: string;
+  name: string;
+  iconUrl: string;
+  weeklyActiveUsers: number;
+  shortDescription: string;
+  storeUrl: string;
+  rating: number | undefined;
+}
+
+const operationName = 'WxtDocsUsedBy';
+const query = `query ${operationName}($ids:[String!]!) {
+  chromeExtensions(ids: $ids) {
+    id
+    name
+    iconUrl
+    weeklyActiveUsers
+    shortDescription
+    storeUrl
+    rating
+  }
+}`;
+
+export default function (ids: string[]) {
+  const data = ref<ChromeExtension[]>();
+  const err = ref<unknown>();
+  const isLoading = ref(true);
+
+  fetch('https://queue.wxt.dev/api', {
+    method: 'POST',
+    body: JSON.stringify({
+      operationName,
+      query,
+      variables: { ids },
+    }),
+  })
+    .then(async (res) => {
+      isLoading.value = false;
+      const {
+        data: { chromeExtensions },
+      } = await res.json();
+      data.value = chromeExtensions;
+      err.value = undefined;
+    })
+    .catch((error) => {
+      isLoading.value = false;
+      console.error(error);
+      data.value = undefined;
+      err.value = error;
+    });
+
+  return {
+    data,
+    err,
+    isLoading,
+  };
+}

docs/.vitepress/config.ts

@@ -0,0 +1,247 @@
+import { defineConfig } from 'vitepress';
+import typedocSidebar from '../api/reference/typedoc-sidebar.json';
+import {
+  menuGroup,
+  menuItem,
+  menuRoot,
+  navItem,
+  prepareTypedocSidebar,
+} from './utils/menus';
+import { meta, script } from './utils/head';
+import footnote from 'markdown-it-footnote';
+import { version as wxtVersion } from '../../packages/wxt/package.json';
+import { version as i18nVersion } from '../../packages/i18n/package.json';
+import { version as autoIconsVersion } from '../../packages/auto-icons/package.json';
+import { version as unocssVersion } from '../../packages/unocss/package.json';
+import { version as storageVersion } from '../../packages/storage/package.json';
+import { version as analyticsVersion } from '../../packages/analytics/package.json';
+import knowledge from 'vitepress-knowledge';
+import {
+  groupIconMdPlugin,
+  groupIconVitePlugin,
+  localIconLoader,
+} from 'vitepress-plugin-group-icons';
+import { Feed } from 'feed';
+import { writeFile } from 'node:fs/promises';
+import { join } from 'node:path';
+
+const origin = 'https://wxt.dev';
+
+const title = 'Next-gen Web Extension Framework';
+const titleSuffix = ' – WXT';
+const description =
+  "WXT provides the best developer experience, making it quick, easy, and fun to develop web extensions. With built-in utilities for building, zipping, and publishing your extension, it's easy to get started.";
+const ogTitle = `${title}${titleSuffix}`;
+const ogUrl = origin;
+const ogImage = `${origin}/social-preview.png`;
+
+const otherPackages = {
+  analytics: analyticsVersion,
+  'auto-icons': autoIconsVersion,
+  i18n: i18nVersion,
+  storage: storageVersion,
+  unocss: unocssVersion,
+};
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  extends: knowledge({
+    serverUrl: 'https://knowledge.wxt.dev',
+    paths: {
+      '/': 'docs',
+      '/api/': 'api-reference',
+    },
+    pageSelectors: {
+      'examples.md': '#VPContent > .VPPage',
+    },
+  }),
+
+  titleTemplate: `:title${titleSuffix}`,
+  title: 'WXT',
+  description,
+  vite: {
+    clearScreen: false,
+    plugins: [
+      groupIconVitePlugin({
+        customIcon: {
+          'wxt.config.ts': localIconLoader(
+            import.meta.url,
+            '../public/logo.svg',
+          ),
+        },
+      }),
+    ],
+  },
+  lastUpdated: true,
+  sitemap: {
+    hostname: origin,
+  },
+
+  async buildEnd(site) {
+    // Only construct the RSS document for production builds
+    const { default: blogDataLoader } = await import('./loaders/blog.data');
+    const posts = await blogDataLoader.load();
+    const feed = new Feed({
+      copyright: 'MIT',
+      id: 'wxt',
+      title: 'WXT Blog',
+      link: `${origin}/blog`,
+    });
+    posts.forEach((post) => {
+      feed.addItem({
+        date: post.frontmatter.date,
+        link: new URL(post.url, origin).href,
+        title: post.frontmatter.title,
+        description: post.frontmatter.description,
+      });
+    });
+    console.log('rss.xml:');
+    console.log(feed.rss2());
+    await writeFile(join(site.outDir, 'rss.xml'), feed.rss2(), 'utf8');
+  },
+
+  head: [
+    meta('og:type', 'website'),
+    meta('og:title', ogTitle),
+    meta('og:image', ogImage),
+    meta('og:url', ogUrl),
+    meta('og:description', description),
+    meta('twitter:card', 'summary_large_image', { useName: true }),
+    script('https://umami.aklinker1.io/script.js', {
+      'data-website-id': 'c1840c18-a12c-4a45-a848-55ae85ef7915',
+      async: '',
+    }),
+  ],
+
+  markdown: {
+    config: (md) => {
+      md.use(footnote);
+      md.use(groupIconMdPlugin);
+    },
+  },
+
+  themeConfig: {
+    // https://vitepress.dev/reference/default-theme-config
+    logo: {
+      src: '/logo.svg',
+      alt: 'WXT logo',
+    },
+
+    footer: {
+      message: [
+        '<a class="light-netlify" href="https://www.netlify.com"> <img src="https://www.netlify.com/v3/img/components/netlify-color-bg.svg" alt="Deploys by Netlify" style="display: inline;" /></a>',
+        '<a class="dark-netlify" href="https://www.netlify.com"> <img src="https://www.netlify.com/v3/img/components/netlify-color-accent.svg" alt="Deploys by Netlify" style="display: inline;" /></a>',
+        'Released under the <a href="https://github.com/wxt-dev/wxt/blob/main/LICENSE">MIT License</a>.',
+      ].join('<br/>'),
+      copyright:
+        'Copyright © 2023-present <a href="https://github.com/aklinker1">Aaron Klinker</a>',
+    },
+
+    editLink: {
+      pattern: 'https://github.com/wxt-dev/wxt/edit/main/docs/:path',
+    },
+
+    search: {
+      provider: 'local',
+    },
+
+    socialLinks: [
+      { icon: 'discord', link: 'https://discord.gg/ZFsZqGery9' },
+      { icon: 'github', link: 'https://github.com/wxt-dev/wxt' },
+    ],
+
+    nav: [
+      navItem('Guide', '/guide/installation'),
+      navItem('Examples', '/examples'),
+      navItem('API', '/api/reference/wxt'),
+      navItem('Blog', '/blog'),
+      navItem(`v${wxtVersion}`, [
+        navItem('wxt', [
+          navItem(`v${wxtVersion}`, '/'),
+          navItem(
+            `Changelog`,
+            'https://github.com/wxt-dev/wxt/blob/main/packages/wxt/CHANGELOG.md',
+          ),
+        ]),
+        navItem(
+          'Other Packages',
+          Object.entries(otherPackages).map(([name, version]) =>
+            navItem(`@wxt-dev/${name} — ${version}`, `/${name}`),
+          ),
+        ),
+      ]),
+    ],
+
+    sidebar: {
+      '/guide/': menuRoot([
+        menuGroup('Get Started', '/guide/', [
+          menuItem('Introduction', 'introduction.md'),
+          menuItem('Installation', 'installation.md'),
+        ]),
+        menuGroup('Essentials', '/guide/essentials/', [
+          menuItem('Project Structure', 'project-structure.md'),
+          menuItem('Entrypoints', 'entrypoints.md'),
+          menuGroup(
+            'Configuration',
+            '/guide/essentials/config/',
+            [
+              menuItem('Manifest', 'manifest.md'),
+              menuItem('Browser Startup', 'browser-startup.md'),
+              menuItem('Auto-imports', 'auto-imports.md'),
+              menuItem('Environment Variables', 'environment-variables.md'),
+              menuItem('Runtime Config', 'runtime.md'),
+              menuItem('Vite', 'vite.md'),
+              menuItem('Build Mode', 'build-mode.md'),
+              menuItem('TypeScript', 'typescript.md'),
+              menuItem('Hooks', 'hooks.md'),
+              menuItem('Entrypoint Loaders', 'entrypoint-loaders.md'),
+            ],
+            true,
+          ),
+          menuItem('Extension APIs', 'extension-apis.md'),
+          menuItem('Assets', 'assets.md'),
+          menuItem('Target Different Browsers', 'target-different-browsers.md'),
+          menuItem('Content Scripts', 'content-scripts.md'),
+          menuItem('Storage', 'storage.md'),
+          menuItem('Messaging', 'messaging.md'),
+          menuItem('I18n', 'i18n.md'),
+          menuItem('Scripting', 'scripting.md'),
+          menuItem('WXT Modules', 'wxt-modules.md'),
+          menuItem('Frontend Frameworks', 'frontend-frameworks.md'),
+          menuItem('ES Modules', 'es-modules.md'),
+          menuItem('Remote Code', 'remote-code.md'),
+          menuItem('Unit Testing', 'unit-testing.md'),
+          menuItem('E2E Testing', 'e2e-testing.md'),
+          menuItem('Publishing', 'publishing.md'),
+          menuItem('Testing Updates', 'testing-updates.md'),
+        ]),
+        menuGroup('Resources', '/guide/resources/', [
+          menuItem('Compare', 'compare.md'),
+          menuItem('FAQ', 'faq.md'),
+          menuItem('Community', 'community.md'),
+          menuItem('Upgrading WXT', 'upgrading.md'),
+          menuItem('Migrate to WXT', 'migrate.md'),
+          menuItem('How WXT Works', 'how-wxt-works.md'),
+        ]),
+      ]),
+      '/api/': menuRoot([
+        menuGroup(
+          'CLI Reference',
+          '/api/cli/',
+          [
+            menuItem('wxt', 'wxt.md'),
+            menuItem('wxt build', 'wxt-build.md'),
+            menuItem('wxt zip', 'wxt-zip.md'),
+            menuItem('wxt prepare', 'wxt-prepare.md'),
+            menuItem('wxt clean', 'wxt-clean.md'),
+            menuItem('wxt init', 'wxt-init.md'),
+            menuItem('wxt submit', 'wxt-submit.md'),
+            menuItem('wxt submit init', 'wxt-submit-init.md'),
+          ],
+          true,
+        ),
+        menuGroup('API Reference', prepareTypedocSidebar(typedocSidebar), true),
+      ]),
+    },
+  },
+});

docs/.vitepress/loaders/blog.data.ts

@@ -0,0 +1,3 @@
+import { createContentLoader } from 'vitepress';
+
+export default createContentLoader('blog/*.md');

docs/.vitepress/loaders/cli.data.ts

@@ -0,0 +1,61 @@
+import { resolve } from 'node:path';
+import consola from 'consola';
+import spawn from 'nano-spawn';
+
+const cliDir = resolve('packages/wxt/src/cli/commands');
+const cliDirGlob = resolve(cliDir, '**');
+
+export default {
+  watch: [cliDirGlob],
+  async load() {
+    consola.info(`Generating CLI docs`);
+
+    const [wxt, build, zip, prepare, clean, init, submit, submitInit] =
+      await Promise.all([
+        getWxtHelp(''),
+        getWxtHelp('build'),
+        getWxtHelp('zip'),
+        getWxtHelp('prepare'),
+        getWxtHelp('clean'),
+        getWxtHelp('init'),
+        getPublishExtensionHelp(''),
+        getPublishExtensionHelp('init'),
+      ]);
+
+    consola.success(`Generated CLI docs`);
+    return {
+      wxt,
+      build,
+      zip,
+      prepare,
+      clean,
+      init,
+      submit,
+      submitInit,
+    };
+  },
+};
+
+async function getHelp(command: string): Promise<string> {
+  const args = command.split(' ');
+  const res = await spawn(args[0], [...args.slice(1), '--help'], {
+    cwd: 'packages/wxt',
+  });
+  return res.stdout;
+}
+
+function getWxtHelp(command: string): Promise<string> {
+  return getHelp(`pnpm -s wxt ${command}`.trim());
+}
+
+async function getPublishExtensionHelp(command: string): Promise<string> {
+  const res = await getHelp(
+    `./node_modules/.bin/publish-extension ${command}`.trim(),
+  );
+  return res.replace(/\$ publish-extension/g, '$ wxt submit');
+}
+
+export interface Command {
+  name: string;
+  docs: string;
+}

docs/.vitepress/theme/custom.css

@@ -0,0 +1,68 @@
+/* Colors */
+:root {
+  --wxt-c-green-1: #0b8a00;
+  --wxt-c-green-2: #096600;
+  --wxt-c-green-3: #096600;
+  --wxt-c-green-soft: rgba(11, 138, 0, 0.14);
+}
+
+.dark {
+  --wxt-c-green-1: #67d45e;
+  --wxt-c-green-2: #329929;
+  --wxt-c-green-3: #21651b;
+  --wxt-c-green-soft: rgba(103, 212, 94, 0.14);
+}
+
+/* https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css */
+
+:root {
+  --vp-c-brand-1: var(--wxt-c-green-1);
+  --vp-c-brand-2: var(--wxt-c-green-2);
+  --vp-c-brand-3: var(--wxt-c-green-3);
+  --vp-c-brand-soft: var(--wxt-c-green-soft);
+}
+
+/* Customize Individual Components */
+
+.vp-doc .no-vertical-dividers th,
+.vp-doc .no-vertical-dividers td {
+  border: none;
+}
+
+.vp-doc .no-vertical-dividers tr {
+  border: 1px solid var(--vp-c-divider);
+}
+
+body {
+  overflow-y: scroll;
+}
+
+.VPSidebar {
+  user-select: none;
+}
+
+.VPSidebarItem .badge {
+  display: inline-block;
+  min-width: 1.6em;
+  padding: 0.3em 0.4em 0.2em;
+  border-radius: 1rem;
+  font-size: 0.75em;
+  line-height: 1;
+  margin-left: 0.5rem;
+  text-align: center;
+  vertical-align: middle;
+  background-color: var(--vp-c-default-2);
+}
+
+.light-netlify {
+  display: inline;
+}
+.dark .light-netlify {
+  display: none;
+}
+.dark-netlify {
+  display: none;
+}
+.dark .dark-netlify {
+  display: inline;
+}

docs/.vitepress/theme/index.ts

@@ -0,0 +1,20 @@
+import DefaultTheme from 'vitepress/theme';
+import Icon from '../components/Icon.vue';
+import EntrypointPatterns from '../components/EntrypointPatterns.vue';
+import UsingWxtSection from '../components/UsingWxtSection.vue';
+import ExampleSearch from '../components/ExampleSearch.vue';
+import BlogLayout from '../components/BlogLayout.vue';
+import './custom.css';
+import 'virtual:group-icons.css';
+
+export default {
+  extends: DefaultTheme,
+  enhanceApp(ctx) {
+    ctx.app
+      .component('Icon', Icon)
+      .component('EntrypointPatterns', EntrypointPatterns)
+      .component('UsingWxtSection', UsingWxtSection)
+      .component('ExampleSearch', ExampleSearch)
+      .component('blog', BlogLayout);
+  },
+};

docs/.vitepress/utils/head.ts

@@ -0,0 +1,28 @@
+import { HeadConfig } from 'vitepress/types/shared';
+
+export function meta(
+  property: string,
+  content: string,
+  options?: { useName: boolean },
+): HeadConfig {
+  return [
+    'meta',
+    {
+      [options?.useName ? 'name' : 'property']: property,
+      content,
+    },
+  ];
+}
+
+export function script(
+  src: string,
+  props: Record<string, string> = {},
+): HeadConfig {
+  return [
+    'script',
+    {
+      ...props,
+      src,
+    },
+  ];
+}

docs/.vitepress/utils/menus.ts

@@ -0,0 +1,107 @@
+import { DefaultTheme } from 'vitepress';
+
+type SidebarItem = DefaultTheme.SidebarItem;
+type NavItem = DefaultTheme.NavItem;
+type NavItemWithLink = DefaultTheme.NavItemWithLink;
+type NavItemWithChildren = DefaultTheme.NavItemWithChildren;
+type NavItemChildren = DefaultTheme.NavItemChildren;
+
+export function navItem(text: string): NavItemChildren;
+export function navItem(text: string, link: string): NavItemChildren;
+export function navItem(text: string, items: any[]): NavItemWithChildren;
+export function navItem(text: string, arg2?: unknown): any {
+  if (typeof arg2 === 'string') {
+    return { text, link: arg2 };
+  } else if (Array.isArray(arg2)) {
+    return { text, items: arg2 };
+  }
+  return { text };
+}
+
+export function menuRoot(items: SidebarItem[]) {
+  return items.map((item, index) => {
+    // item.collapsed = false; // uncomment to expand all level-0 items
+    return item;
+  });
+}
+
+export function menuGroup(
+  text: string,
+  items: SidebarItem[],
+  collapsible?: boolean,
+): SidebarItem;
+export function menuGroup(
+  text: string,
+  base: string,
+  items: SidebarItem[],
+  collapsible?: boolean,
+): SidebarItem;
+export function menuGroup(
+  text: string,
+  a: string | SidebarItem[],
+  b?: SidebarItem[] | boolean,
+  c?: boolean,
+): SidebarItem {
+  if (typeof a === 'string' && Array.isArray(b)) {
+    return {
+      text,
+      base: a,
+      items: b,
+      collapsed: c,
+    };
+  }
+  if (typeof a !== 'string' && !Array.isArray(b))
+    return {
+      text,
+      items: a,
+      collapsed: b,
+    };
+
+  throw Error('Unknown overload');
+}
+
+export function menuItems(items: SidebarItem[]) {
+  return {
+    items,
+  };
+}
+
+export function menuItem(
+  text: string,
+  link: string,
+  items?: SidebarItem[],
+): SidebarItem {
+  if (items) {
+    return { text, link, items };
+  }
+  return { text, link };
+}
+
+/**
+ * Clean up and add badges to typedoc leaf sections
+ */
+export function prepareTypedocSidebar(items: SidebarItem[]) {
+  // skip contents file
+  const filtered = items.slice(1);
+
+  // remove Typedoc's collapse: true from text nodes
+  const prepareItems = (items: DefaultTheme.SidebarItem[], depth = 0) => {
+    for (const item of items) {
+      if (item.items) {
+        prepareItems(item.items, depth + 1);
+        const hasLeaves = item.items.some((item) => !item.items);
+        if (hasLeaves) {
+          item.text += ` <span class="badge">${item.items.length}</span>`;
+        }
+      } else {
+        delete item.collapsed;
+      }
+    }
+  };
+
+  // process
+  prepareItems(filtered);
+
+  // return
+  return filtered;
+}

docs/.vitepress/utils/types.ts

@@ -0,0 +1,18 @@
+export interface Example {
+  name: string;
+  description?: string;
+  url: string;
+  searchText: string;
+  apis: string[];
+  permissions: string[];
+  packages: string[];
+}
+
+export type ExamplesMetadata = {
+  examples: Example[];
+  allApis: string[];
+  allPermissions: string[];
+  allPackages: string[];
+};
+
+export type KeySelectedObject = Record<string, boolean | undefined>;

docs/analytics.md

@@ -0,0 +1 @@
+<!--@include: ../packages/analytics/README.md-->

docs/api/cli/wxt-build.md

@@ -0,0 +1,7 @@
+# `wxt build`
+
+<script setup>
+import { data } from '../../.vitepress/loaders/cli.data.ts'
+</script>
+
+<div class="language-sh vp-adaptive-theme active"><pre class="shiki shiki-themes github-light github-dark vp-code"><code>{{ data.build }}</code></pre></div>

docs/api/cli/wxt-clean.md

@@ -0,0 +1,7 @@
+# `wxt clean`
+
+<script setup>
+import { data } from '../../.vitepress/loaders/cli.data.ts'
+</script>
+
+<div class="language-sh vp-adaptive-theme active"><pre class="shiki shiki-themes github-light github-dark vp-code"><code>{{ data.clean }}</code></pre></div>

docs/api/cli/wxt-init.md

@@ -0,0 +1,7 @@
+# `wxt init`
+
+<script setup>
+import { data } from '../../.vitepress/loaders/cli.data.ts'
+</script>
+
+<div class="language-sh vp-adaptive-theme active"><pre class="shiki shiki-themes github-light github-dark vp-code"><code>{{ data.init }}</code></pre></div>

docs/api/cli/wxt-prepare.md

@@ -0,0 +1,7 @@
+# `wxt prepare`
+
+<script setup>
+import { data } from '../../.vitepress/loaders/cli.data.ts'
+</script>
+
+<div class="language-sh vp-adaptive-theme active"><pre class="shiki shiki-themes github-light github-dark vp-code"><code>{{ data.prepare }}</code></pre></div>

docs/api/cli/wxt-submit-init.md

@@ -0,0 +1,9 @@
+# `wxt submit init`
+
+> Alias for [`publish-browser-extension`](https://www.npmjs.com/package/publish-browser-extension)
+
+<script setup>
+import { data } from '../../.vitepress/loaders/cli.data.ts'
+</script>
+
+<div class="language-sh vp-adaptive-theme active"><pre class="shiki shiki-themes github-light github-dark vp-code"><code>{{ data.submitInit }}</code></pre></div>

docs/api/cli/wxt-submit.md

@@ -0,0 +1,9 @@
+# `wxt submit`
+
+> Alias for [`publish-browser-extension`](https://www.npmjs.com/package/publish-browser-extension)
+
+<script setup>
+import { data } from '../../.vitepress/loaders/cli.data.ts'
+</script>
+
+<div class="language-sh vp-adaptive-theme active"><pre class="shiki shiki-themes github-light github-dark vp-code"><code>{{ data.submit }}</code></pre></div>

docs/api/cli/wxt-zip.md

@@ -0,0 +1,7 @@
+# `wxt zip`
+
+<script setup>
+import { data } from '../../.vitepress/loaders/cli.data.ts'
+</script>
+
+<div class="language-sh vp-adaptive-theme active"><pre class="shiki shiki-themes github-light github-dark vp-code"><code>{{ data.zip }}</code></pre></div>

docs/api/cli/wxt.md

@@ -0,0 +1,7 @@
+# `wxt`
+
+<script setup>
+import { data } from '../../.vitepress/loaders/cli.data.ts'
+</script>
+
+<div class="language-sh vp-adaptive-theme active"><pre class="shiki shiki-themes github-light github-dark vp-code"><code>{{ data.wxt }}</code></pre></div>

docs/auto-icons.md

@@ -0,0 +1 @@
+<!--@include: ../packages/auto-icons/README.md-->

docs/blog.md

@@ -0,0 +1,9 @@
+---
+layout: page
+---
+
+<script lang="ts" setup>
+import BlogHome from './.vitepress/components/BlogHome.vue';
+</script>
+
+<BlogHome />

docs/blog/.drafts/2024-10-19-real-world-messaging.md

@@ -0,0 +1,12 @@
+---
+layout: blog
+title: Real World Messaging
+description: |
+  The extension messaging APIs are difficult to learn. Let's go beyond the simple examples from Chrome and Firefox's documentation to build our own simple messaging system from scratch.
+authors:
+  - name: Aaron Klinker
+    github: aklinker1
+date: 2024-10-20T04:54:23.601Z
+---
+
+Test content **bold** _italic_

docs/blog/2024-12-06-using-imports-module.md

@@ -0,0 +1,72 @@
+---
+layout: blog
+title: Introducing <code>#imports</code>
+description: Learn how WXT's new <code>#imports</code> module works and how to use it.
+authors:
+  - name: Aaron Klinker
+    github: aklinker1
+date: 2024-12-06T14:39:00.000Z
+---
+
+WXT v0.20 introduced a new way of manually importing its APIs: **the `#imports` module**. This module was introduced to simplify import statements and provide more visibility into all the APIs WXT provides.
+
+<!-- prettier-ignore -->
+```ts
+import { browser } from 'wxt/browser'; // [!code --]
+import { createShadowRootUi } from 'wxt/utils/content-script-ui/shadow-root'; // [!code --]
+import { defineContentScript } from 'wxt/utils/define-content-script'; // [!code --]
+import { injectScript } from 'wxt/utils/inject-script'; // [!code --]
+import { // [!code ++]
+  browser, createShadowRootUi, defineContentScript, injectScript // [!code ++]
+} from '#imports'; // [!code ++]
+```
+
+The `#imports` module is considered a "virtual module", because the file doesn't actually exist. At build-time, imports are split into individual statements for each API:
+
+:::code-group
+
+```ts [What you write]
+import { defineContentScript, injectScript } from '#imports';
+```
+
+```ts [What the bundler sees]
+import { defineContentScript } from 'wxt/utils/define-content-script';
+import { injectScript } from 'wxt/utils/inject-script';
+```
+
+:::
+
+Think of `#imports` as a convenient way to access all of WXT's APIs from one place, without impacting performance or bundle size.
+
+This enables better tree-shaking compared to v0.19 and below.
+
+:::tip Need to lookup the full import path of an API?
+Open up your project's `.wxt/types/imports-module.d.ts` file.
+:::
+
+## Mocking
+
+When writing tests, you might need to mock APIs from the `#imports` module. While mocking these APIs is very easy, it may not be immediately clear how to accomplish it.
+
+Let's look at an example using Vitest. When [configured with `wxt/testing`](/guide/essentials/unit-testing#vitest), Vitest sees the same transformed code as the bundler. That means to mock an API from `#imports`, you need to call `vi.mock` with the real import path, not `#imports`:
+
+```ts
+import { injectScript } from '#imports';
+import { vi } from 'vitest';
+
+vi.mock('wxt/utils/inject-script')
+const injectScriptMock = vi.mocked(injectScript);
+
+injectScriptMock.mockReturnValueOnce(...);
+```
+
+## Conclusion
+
+You don't have to use `#imports` if you don't like - you can continue importing APIs from their submodules. However, using `#imports` is the recommended approach moving forwards.
+
+- As more APIs are added, you won't have to memorize additional import paths.
+- If breaking changes are made to import paths in future major versions, `#imports` won't break.
+
+Happy Coding 😄
+
+> P.S. Yes, this is exactly how [Nuxt's `#imports`](https://nuxt.com/docs/guide/concepts/auto-imports#explicit-imports) works! We use the exact same library, [`unimport`](https://github.com/unjs/unimport).

docs/examples.md

@@ -0,0 +1,19 @@
+---
+layout: page
+---
+
+<style>
+.examples-container {
+  padding: 32px;
+}
+</style>
+
+<div class="examples-container">
+  <div class="vp-doc">
+    <h1>Examples</h1>
+  </div>
+
+  <br />
+
+  <ExampleSearch />
+</div>

docs/guide/essentials/assets.md

@@ -0,0 +1,188 @@
+# Assets
+
+## `/assets` Directory
+
+Any assets imported or referenced inside the `<srcDir>/assets/` directory will be processed by WXT's bundler.
+
+Here's how you access them:
+
+:::code-group
+
+```ts [JS]
+import imageUrl from '~/assets/image.png';
+
+const img = document.createElement('img');
+img.src = imageUrl;
+```
+
+```html [HTML]
+<!-- In HTML tags, you must use the relative path --->
+<img src="../assets/image.png" />
+```
+
+```css [CSS]
+.bg-image {
+  background-image: url(~/assets/image.png);
+}
+```
+
+```vue [Vue]
+<script>
+import image from '~/assets/image.png';
+</script>
+
+<template>
+  <img :src="image" />
+</template>
+```
+
+```jsx [JSX]
+import image from '~/assets/image.png';
+
+<img src={image} />;
+```
+
+:::
+
+## `/public` Directory
+
+Files inside `<rootDir>/public/` are copied into the output folder as-is, without being processed by WXT's bundler.
+
+Here's how you access them:
+
+:::code-group
+
+```ts [JS]
+import imageUrl from '/image.png';
+
+const img = document.createElement('img');
+img.src = imageUrl;
+```
+
+```html [HTML]
+<img src="/image.png" />
+```
+
+```css [CSS]
+.bg-image {
+  background-image: url(/image.png);
+}
+```
+
+```vue [Vue]
+<template>
+  <img src="/image.png" />
+</template>
+```
+
+```jsx [JSX]
+<img src="/image.png" />
+```
+
+:::
+
+:::warning
+Assets in the `public/` directory are **_not_** accessible in content scripts by default. To use a public asset in a content script, you must add it to your manifest's [`web_accessible_resources` array](/api/reference/wxt/type-aliases/UserManifest#web-accessible-resources).
+:::
+
+## Inside Content Scripts
+
+Assets inside content scripts are a little different. By default, when you import an asset, it returns just the path to the asset. This is because Vite assumes you're loading assets from the same hostname.
+
+But, inside content scripts, the hostname is whatever the tab is set to. So if you try to fetch the asset, manually or as an `<img>`'s `src`, it will be loaded from the tab's website, not your extension.
+
+To fix this, you need to convert the image to a full URL using `browser.runtime.getURL`:
+
+```ts [entrypoints/content.ts]
+import iconUrl from '/icon/128.png';
+
+export default defineContentScript({
+  matches: ['*://*.google.com/*'],
+  main() {
+    console.log(iconUrl); // "/icon/128.png"
+    console.log(browser.runtime.getURL(iconUrl)); // "chrome-extension://<id>/icon/128.png"
+  },
+});
+```
+
+## WASM
+
+How a `.wasm` file is loaded varies greatly between packages, but most follow a basic setup: Use a JS API to load and execute the `.wasm` file.
+
+For an extension, that means two things:
+
+1. The `.wasm` file needs to be present in output folder so it can be loaded.
+2. You must import the JS API to load and initialize the `.wasm` file, usually provided by the NPM package.
+
+For an example, let's say you have a content script needs to parse TS code into AST. We'll use [`@oxc-parser/wasm`](https://www.npmjs.com/package/@oxc-parser/wasm) to do it!
+
+First, we need to copy the `.wasm` file to the output directory. We'll do it with a [WXT module](/guide/essentials/wxt-modules):
+
+```ts
+// modules/oxc-parser-wasm.ts
+import { resolve } from 'node:path';
+
+export default defineWxtModule((wxt) => {
+  wxt.hook('build:publicAssets', (_, assets) => {
+    assets.push({
+      absoluteSrc: resolve(
+        'node_modules/@oxc-parser/wasm/web/oxc_parser_wasm_bg.wasm',
+      ),
+      relativeDest: 'oxc_parser_wasm_bg.wasm',
+    });
+  });
+});
+```
+
+Run `wxt build`, and you should see the WASM file copied into your `.output/chrome-mv3` folder!
+
+Next, since this is in a content script and we'll be fetching the WASM file over the network to load it, we need to add the file to the `web_accessible_resources`:
+
+```ts [wxt.config.ts]
+export default defineConfig({
+  manifest: {
+    web_accessible_resources: [
+      {
+        // We'll use this matches in the content script as well
+        matches: ['*://*.github.com/*'],
+        // Use the same path as `relativeDest` from the WXT module
+        resources: ['/oxc_parser_wasm_bg.wasm'],
+      },
+    ],
+  },
+});
+```
+
+And finally, we need to load and initialize the `.wasm` file inside the content script to use it:
+
+```ts [entrypoints/content.ts]
+import initWasm, { parseSync } from '@oxc-parser/wasm';
+
+export default defineContentScript({
+  matches: '*://*.github.com/*',
+  async main(ctx) {
+    if (!location.pathname.endsWith('.ts')) return;
+
+    // Get text from GitHub
+    const code = document.getElementById(
+      'read-only-cursor-text-area',
+    )?.textContent;
+    if (!code) return;
+    const sourceFilename = document.getElementById('file-name-id')?.textContent;
+    if (!sourceFilename) return;
+
+    // Load the WASM file:
+    await initWasm({
+      module_or_path: browser.runtime.getURL('/oxc_parser_wasm_bg.wasm'),
+    });
+
+    // Once loaded, we can use `parseSync`!
+    const ast = parseSync(code, { sourceFilename });
+    console.log(ast);
+  },
+});
+```
+
+This code is taken directly from `@oxc-parser/wasm` docs with one exception: We manually pass in a file path. In a standard NodeJS or web project, the default path works just fine so you don't have to pass anything in. However, extensions are different. You should always explicitly pass in the full URL to the WASM file in your output directory, which is what `browser.runtime.getURL` returns.
+
+Run your extension, and you should see OXC parse the TS file!

docs/guide/essentials/config/auto-imports.md

@@ -0,0 +1,118 @@
+# Auto-imports
+
+WXT uses [`unimport`](https://www.npmjs.com/package/unimport), the same tool as Nuxt, to setup auto-imports.
+
+```ts
+export default defineConfig({
+  // See https://www.npmjs.com/package/unimport#configurations
+  imports: {
+    // ...
+  },
+});
+```
+
+By default, WXT automatically sets up auto-imports for all of it's own APIs and some of your project directories:
+
+- `<srcDir>/components/*`
+- `<srcDir>/composables/*`
+- `<srcDir>/hooks/*`
+- `<srcDir>/utils/*`
+
+All named and default exports from files in these directories are available everywhere else in your project without having to import them.
+
+To see the complete list of auto-imported APIs, run [`wxt prepare`](/api/cli/wxt-prepare) and look at your project's `.wxt/types/imports-module.d.ts` file.
+
+## TypeScript
+
+For TypeScript and your editor to recognize auto-imported variables, you need to run the [`wxt prepare` command](/api/cli/wxt-prepare).
+
+Add this command to your `postinstall` script so your editor has everything it needs to report type errors after installing dependencies:
+
+```jsonc
+// package.json
+{
+  "scripts": {
+    "postinstall": "wxt prepare", // [!code ++]
+  },
+}
+```
+
+## ESLint
+
+ESLint doesn't know about the auto-imported variables unless they are explicitly defined in the ESLint's `globals`. By default, WXT will generate the config if it detects ESLint is installed in your project. If the config isn't generated automatically, you can manually tell WXT to generate it.
+
+:::code-group
+
+```ts [ESLint 9]
+export default defineConfig({
+  imports: {
+    eslintrc: {
+      enabled: 9,
+    },
+  },
+});
+```
+
+```ts [ESLint 8]
+export default defineConfig({
+  imports: {
+    eslintrc: {
+      enabled: 8,
+    },
+  },
+});
+```
+
+:::
+
+Then in your ESLint config, import and use the generated file:
+
+:::code-group
+
+```js [ESLint 9]
+// eslint.config.mjs
+import autoImports from './.wxt/eslint-auto-imports.mjs';
+
+export default [
+  autoImports,
+  {
+    // The rest of your config...
+  },
+];
+```
+
+```js [ESLint 8]
+// .eslintrc.mjs
+export default {
+  extends: ['./.wxt/eslintrc-auto-import.json'],
+  // The rest of your config...
+};
+```
+
+:::
+
+## Disabling Auto-imports
+
+Not all developers like auto-imports. To disable them, set `imports` to `false`.
+
+```ts
+export default defineConfig({
+  imports: false, // [!code ++]
+});
+```
+
+## Explicit Imports (`#imports`)
+
+You can manually import all of WXT's APIs via the `#imports` module:
+
+```ts
+import {
+  createShadowRootUi,
+  ContentScriptContext,
+  MatchPattern,
+} from '#imports';
+```
+
+To learn more about how the `#imports` module works, read the [related blog post](/blog/2024-12-06-using-imports-module).
+
+If you've disabled auto-imports, you should still use `#imports` to import all of WXT's APIs from a single place.

docs/guide/essentials/config/browser-startup.md

@@ -0,0 +1,88 @@
+---
+outline: deep
+---
+
+# Browser Startup
+
+> See the [API Reference](/api/reference/wxt/interfaces/WebExtConfig) for a full list of config.
+
+During development, WXT uses [`web-ext` by Mozilla](https://www.npmjs.com/package/web-ext) to automatically open a browser window with your extension installed.
+
+## Config Files
+
+You can configure browser startup in 3 places:
+
+1. `<rootDir>/web-ext.config.ts`: Ignored from version control, this file lets you configure your own options for a specific project without affecting other developers
+
+   ```ts
+   import { defineWebExtConfig } from 'wxt';
+
+   export default defineWebExtConfig({
+     // ...
+   });
+   ```
+
+2. `<rootDir>/wxt.config.ts`: Via the [`runner` config](/api/reference/wxt/interfaces/InlineConfig#runner), included in version control
+3. `$HOME/web-ext.config.ts`: Provide default values for all WXT projects on your computer
+
+## Recipes
+
+### Set Browser Binaries
+
+To set or customize the browser opened during development:
+
+```ts
+export default defineWebExtConfig({
+  binaries: {
+    chrome: '/path/to/chrome-beta', // Use Chrome Beta instead of regular Chrome
+    firefox: 'firefoxdeveloperedition', // Use Firefox Developer Edition instead of regular Firefox
+    edge: '/path/to/edge', // Open MS Edge when running "wxt -b edge"
+  },
+});
+```
+
+By default, WXT will try to automatically discover where Chrome/Firefox are installed. However, if you have chrome installed in a non-standard location, you need to set it manually as shown above.
+
+### Persist Data
+
+By default, to keep from modifying your browser's existing profiles, `web-ext` creates a brand new profile every time you run the `dev` script.
+
+Right now, Chromium based browsers are the only browsers that support overriding this behavior and persisting data when running the `dev` script multiple times.
+
+To persist data, set the `--user-data-dir` flag:
+
+:::code-group
+
+```ts [Mac/Linux]
+export default defineWebExtConfig({
+  chromiumArgs: ['--user-data-dir=./.wxt/chrome-data'],
+});
+```
+
+```ts [Windows]
+import { resolve } from 'node:path';
+
+export default defineWebExtConfig({
+  // On Windows, the path must be absolute
+  chromiumProfile: resolve('.wxt/chrome-data'),
+  keepProfileChanges: true,
+});
+```
+
+:::
+
+Now, next time you run the `dev` script, a persistent profile will be created in `.wxt/chrome-data/{profile-name}`. With a persistent profile, you can install devtools extensions to help with development, allow the browser to remember logins, etc, without worrying about the profile being reset the next time you run the `dev` script.
+
+:::tip
+You can use any directory you'd like for `--user-data-dir`, the examples above create a persistent profile for each WXT project. To create a profile for all WXT projects, you can put the `chrome-data` directory inside your user's home directory.
+:::
+
+### Disable Opening Browser
+
+If you prefer to load the extension into your browser manually, you can disable the auto-open behavior:
+
+```ts
+export default defineWebExtConfig({
+  disabled: true,
+});
+```

docs/guide/essentials/config/build-mode.md

@@ -0,0 +1,29 @@
+# Build Modes
+
+Because WXT is powered by Vite, it supports [modes](https://vite.dev/guide/env-and-mode.html#modes) in the same way.
+
+When running any dev or build commands, pass the `--mode` flag:
+
+```sh
+wxt --mode production
+wxt build --mode development
+wxt zip --mode testing
+```
+
+By default, `--mode` is `development` for the dev command and `production` for all other commands (build, zip, etc).
+
+## Get Mode at Runtime
+
+You can access the current mode in your extension using `import.meta.env.MODE`:
+
+```ts
+switch (import.meta.env.MODE) {
+  case 'development': // ...
+  case 'production': // ...
+
+  // Custom modes specified with --mode
+  case 'testing': // ...
+  case 'staging': // ...
+  // ...
+}
+```

docs/guide/essentials/config/entrypoint-loaders.md

@@ -0,0 +1,19 @@
+# Entrypoint Loaders
+
+To generate the manifest and other files at build-time, WXT must import each entrypoint to get their options, like content script `matches`. For HTML files, this is easy. For JS/TS entrypoints, the process is more complicated.
+
+When loading your JS/TS entrypoints, they are imported into a NodeJS environment, not the `browser` environment that they normally run in. This can lead to issues commonly seen when running browser-only code in a NodeJS environment, like missing global variables.
+
+WXT does several pre-processing steps to try and prevent errors during this process:
+
+1. Use `linkedom` to make a small set of browser globals (`window`, `document`, etc) available.
+2. Use `@webext-core/fake-browser` to create a fake version of the `chrome` and `browser` globals expected by extensions.
+3. Pre-process the JS/TS code, stripping out the `main` function then tree-shaking unused code from the file
+
+However, this process is not perfect. It doesn't setup all the globals found in the browser and the APIs may behave differently. As such, **_you should avoid using browser or extension APIs outside the `main` function of your entrypoints!_**
+
+:::tip
+If you're running into errors while importing entrypoints, run `wxt prepare --debug` to see more details about this process. When debugging, WXT will print out the pre-processed code to help you identify issues.
+:::
+
+Once the environment has been polyfilled and your code pre-processed, it's up the entrypoint loader to import your code, extracting the options from the default export.

docs/guide/essentials/config/environment-variables.md

@@ -0,0 +1,81 @@
+# Environment Variables
+
+## Dotenv Files
+
+WXT supports [dotenv files the same way as Vite](https://vite.dev/guide/env-and-mode.html#env-files). Create any of the following files:
+
+```
+.env
+.env.local
+.env.[mode]
+.env.[mode].local
+.env.[browser]
+.env.[browser].local
+.env.[mode].[browser]
+.env.[mode].[browser].local
+```
+
+And any environment variables listed inside them will be available at runtime:
+
+```sh
+# .env
+WXT_API_KEY=...
+```
+
+```ts
+await fetch(`/some-api?apiKey=${import.meta.env.WXT_API_KEY}`);
+```
+
+Remember to prefix any environment variables with `WXT_` or `VITE_`, otherwise they won't be available at runtime, as per [Vite's convention](https://vite.dev/guide/env-and-mode.html#env-files).
+
+## Built-in Environment Variables
+
+WXT provides some custom environment variables based on the current command:
+
+| Usage                              | Type      | Description                                           |
+| ---------------------------------- | --------- | ----------------------------------------------------- |
+| `import.meta.env.MANIFEST_VERSION` | `2 │ 3`   | The target manifest version                           |
+| `import.meta.env.BROWSER`          | `string`  | The target browser                                    |
+| `import.meta.env.CHROME`           | `boolean` | Equivalent to `import.meta.env.BROWSER === "chrome"`  |
+| `import.meta.env.FIREFOX`          | `boolean` | Equivalent to `import.meta.env.BROWSER === "firefox"` |
+| `import.meta.env.SAFARI`           | `boolean` | Equivalent to `import.meta.env.BROWSER === "safari"`  |
+| `import.meta.env.EDGE`             | `boolean` | Equivalent to `import.meta.env.BROWSER === "edge"`    |
+| `import.meta.env.OPERA`            | `boolean` | Equivalent to `import.meta.env.BROWSER === "opera"`   |
+
+You can also access all of [Vite's environment variables](https://vite.dev/guide/env-and-mode.html#env-variables):
+
+| Usage                  | Type      | Description                                                                 |
+| ---------------------- | --------- | --------------------------------------------------------------------------- |
+| `import.meta.env.MODE` | `string`  | The [mode](/guide/essentials/config/build-mode) the extension is running in |
+| `import.meta.env.PROD` | `boolean` | When `NODE_ENV='production'`                                                |
+| `import.meta.env.DEV`  | `boolean` | Opposite of `import.meta.env.PROD`                                          |
+
+:::details Other Vite Environment Variables
+Vite provides two other environment variables, but they aren't useful in WXT projects:
+
+- `import.meta.env.BASE_URL`: Use `browser.runtime.getURL` instead.
+- `import.meta.env.SSR`: Always `false`.
+  :::
+
+## Manifest
+
+To use environment variables in the manifest, you need to use the function syntax:
+
+```ts
+export default defineConfig({
+  extensionApi: 'chrome',
+  modules: ['@wxt-dev/module-vue'],
+  manifest: { // [!code --]
+    oauth2: { // [!code --]
+      client_id: import.meta.env.WXT_APP_CLIENT_ID // [!code --]
+    } // [!code --]
+  } // [!code --]
+  manifest: () => ({ // [!code ++]
+    oauth2: { // [!code ++]
+      client_id: import.meta.env.WXT_APP_CLIENT_ID // [!code ++]
+    } // [!code ++]
+  }), // [!code ++]
+});
+```
+
+WXT can't load your `.env` files until after the config file has been loaded. So by using the function syntax for `manifest`, it defers creating the object until after the `.env` files are loaded into the process.

docs/guide/essentials/config/hooks.md

@@ -0,0 +1,57 @@
+# Hooks
+
+WXT includes a system that lets you hook into the build process and make changes.
+
+## Adding Hooks
+
+The easiest way to add a hook is via the `wxt.config.ts`. Here's an example hook that modifies the `manifest.json` file before it is written to the output directory:
+
+```ts [wxt.config.ts]
+export default defineConfig({
+  hooks: {
+    'build:manifestGenerated': (wxt, manifest) => {
+      if (wxt.config.mode === 'development') {
+        manifest.title += ' (DEV)';
+      }
+    },
+  },
+});
+```
+
+Most hooks provide the `wxt` object as the first argument. It contains the resolved config and other info about the current build. The other arguments can be modified by reference to change different parts of the build system.
+
+Putting one-off hooks like this in your config file is simple, but if you find yourself writing lots of hooks, you should extract them into [WXT Modules](/guide/essentials/wxt-modules) instead.
+
+## Execution Order
+
+Because hooks can be defined in multiple places, including [WXT Modules](/guide/essentials/wxt-modules), the order which they're executed can matter. Hooks are executed in the following order:
+
+1. NPM modules in the order listed in the [`modules` config](/api/reference/wxt/interfaces/InlineConfig#modules)
+2. User modules in [`/modules` folder](/guide/essentials/project-structure), loaded alphabetically
+3. Hooks listed in your `wxt.config.ts`
+
+To see the order for your project, run `wxt prepare --debug` flag and search for the "Hook execution order":
+
+```
+⚙ Hook execution order:
+⚙   1. wxt:built-in:unimport
+⚙   2. src/modules/auto-icons.ts
+⚙   3. src/modules/example.ts
+⚙   4. src/modules/i18n.ts
+⚙   5. wxt.config.ts > hooks
+```
+
+Changing execution order is simple:
+
+- Prefix your user modules with a number (lower numbers are loaded first):
+  <!-- prettier-ignore -->
+  ```html
+  📁 modules/
+     📄 0.my-module.ts
+     📄 1.another-module.ts
+  ```
+- If you need to run an NPM module after user modules, just make it a user module and prefix the filename with a number!
+  ```ts
+  // modules/2.i18n.ts
+  export { default } from '@wxt-dev/i18n/module';
+  ```

docs/guide/essentials/config/manifest.md

@@ -0,0 +1,255 @@
+# Manifest
+
+In WXT, there is no `manifest.json` file in your source code. Instead, WXT generates the manifest from multiple sources:
+
+- Global options [defined in your `wxt.config.ts` file](#global-options)
+- Entrypoint-specific options [defined in your entrypoints](/guide/essentials/entrypoints#defining-manifest-options)
+- [WXT Modules](/guide/essentials/wxt-modules) added to your project can modify your manifest
+- [Hooks](/guide/essentials/config/hooks) defined in your project can modify your manifest
+
+Your extension's `manifest.json` will be output to `.output/{target}/manifest.json` when running `wxt build`.
+
+## Global Options
+
+To add a property to your manifest, use the `manifest` config inside your `wxt.config.ts`:
+
+```ts
+export default defineConfig({
+  manifest: {
+    // Put manual changes here
+  },
+});
+```
+
+You can also define the manifest as a function, and use JS to generate it based on the target browser, mode, and more.
+
+```ts
+export default defineConfig({
+  manifest: ({ browser, manifestVersion, mode, command }) => {
+    return {
+      // ...
+    };
+  },
+});
+```
+
+### MV2 and MV3 Compatibility
+
+When adding properties to the manifest, always define the property in it's MV3 format when possible. When targeting MV2, WXT will automatically convert these properties to their MV2 format.
+
+For example, for this config:
+
+```ts
+export default defineConfig({
+  manifest: {
+    action: {
+      default_title: 'Some Title',
+    },
+    web_accessible_resources: [
+      {
+        matches: ['*://*.google.com/*'],
+        resources: ['icon/*.png'],
+      },
+    ],
+  },
+});
+```
+
+WXT will generate the following manifests:
+
+:::code-group
+
+```json [MV2]
+{
+  "manifest_version": 2,
+  // ...
+  "browser_action": {
+    "default_title": "Some Title"
+  },
+  "web_accessible_resources": ["icon/*.png"]
+}
+```
+
+```json [MV3]
+{
+  "manifest_version": 3,
+  // ...
+  "action": {
+    "default_title": "Some Title"
+  },
+  "web_accessible_resources": [
+    {
+      "matches": ["*://*.google.com/*"],
+      "resources": ["icon/*.png"]
+    }
+  ]
+}
+```
+
+:::
+
+You can also specify properties specific to a single manifest version, and they will be stripped out when targeting the other manifest version.
+
+## Name
+
+> [Chrome Docs](https://developer.chrome.com/docs/extensions/mv3/manifest/name/)
+
+If not provided via the `manifest` config, the manifest's `name` property defaults to your `package.json`'s `name` property.
+
+## Version and Version Name
+
+> [Chrome Docs](https://developer.chrome.com/docs/extensions/mv3/manifest/version/)
+
+Your extension's `version` and `version_name` is based on the `version` from your `package.json`.
+
+- `version_name` is the exact string listed
+- `version` is the string cleaned up, with any invalid suffixes removed
+
+Example:
+
+```json
+// package.json
+{
+  "version": "1.3.0-alpha2"
+}
+```
+
+```json
+// .output/<target>/manifest.json
+{
+  "version": "1.3.0",
+  "version_name": "1.3.0-alpha2"
+}
+```
+
+If a version is not present in your `package.json`, it defaults to `"0.0.0"`.
+
+## Icons
+
+WXT automatically discovers your extension's icon by looking at files in the `public/` directory:
+
+```
+public/
+├─ icon-16.png
+├─ icon-24.png
+├─ icon-48.png
+├─ icon-96.png
+└─ icon-128.png
+```
+
+Specifically, an icon must match one of these regex to be discovered:
+
+<<< @/../packages/wxt/src/core/utils/manifest.ts#snippet
+
+If you don't like these filename or you're migrating to WXT and don't want to rename the files, you can manually specify an `icon` in your manifest:
+
+```ts
+export default defineConfig({
+  manifest: {
+    icons: {
+      16: '/extension-icon-16.png',
+      24: '/extension-icon-24.png',
+      48: '/extension-icon-48.png',
+      96: '/extension-icon-96.png',
+      128: '/extension-icon-128.png',
+    },
+  },
+});
+```
+
+Alternatively, you can use [`@wxt-dev/auto-icons`](https://www.npmjs.com/package/@wxt-dev/auto-icons) to let WXT generate your icon at the required sizes.
+
+## Permissions
+
+> [Chrome docs](https://developer.chrome.com/docs/extensions/reference/permissions/)
+
+Most of the time, you need to manually add permissions to your manifest. Only in a few specific situations are permissions added automatically:
+
+- During development: the `tabs` and `scripting` permissions will be added to enable hot reloading.
+- When a `sidepanel` entrypoint is present: The `sidepanel` permission is added.
+
+```ts
+export default defineConfig({
+  manifest: {
+    permissions: ['storage', 'tabs'],
+  },
+});
+```
+
+## Host Permissions
+
+> [Chrome docs](https://developer.chrome.com/docs/extensions/develop/concepts/declare-permissions#host-permissions)
+
+```ts
+export default defineConfig({
+  manifest: {
+    host_permissions: ['https://www.google.com/*'],
+  },
+});
+```
+
+:::warning
+If you use host permissions and target both MV2 and MV3, make sure to only include the required host permissions for each version:
+
+```ts
+export default defineConfig({
+  manifest: ({ manifestVersion }) => ({
+    host_permissions: manifestVersion === 2 ? [...] : [...],
+  }),
+});
+```
+
+:::
+
+## Default Locale
+
+```ts
+export default defineConfig({
+  manifest: {
+    name: '__MSG_extName__',
+    description: '__MSG_extDescription__',
+    default_locale: 'en',
+  },
+});
+```
+
+> See [I18n docs](/guide/essentials/i18n) for a full guide on internationalizing your extension.
+
+## Actions
+
+In MV2, you have two options: [`browser_action`](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/browser_action) and [`page_action`](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/page_action). In MV3, they were merged into a single [`action`](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/action) API.
+
+By default, whenever an `action` is generated, WXT falls back to `browser_action` when targeting MV2.
+
+### Action With Popup
+
+To generate a manifest where a UI appears after clicking the icon, just create a [Popup entrypoint](/guide/essentials/entrypoints#popup). If you want to use a `page_action` for MV2, add the following meta tag to the HTML document's head:
+
+```html
+<meta name="manifest.type" content="page_action" />
+```
+
+### Action Without Popup
+
+If you want to use the `activeTab` permission or the `browser.action.onClicked` event, but don't want to show a popup:
+
+1. Delete the [Popup entrypoint](/guide/essentials/entrypoints#popup) if it exists
+2. Add the `action` key to your manifest:
+   ```ts
+   export default defineConfig({
+     manifest: {
+       action: {},
+     },
+   });
+   ```
+
+Same as an action with a popup, WXT will fallback on using `browser_action` for MV2. To use a `page_action` instead, add that key as well:
+
+```ts
+export default defineConfig({
+  manifest: {
+    action: {},
+    page_action: {},
+  },
+});
+```

docs/guide/essentials/config/runtime.md

@@ -0,0 +1,56 @@
+# Runtime Config
+
+> This API is still a WIP, with more features coming soon!
+
+Define runtime configuration in a single place, `<srcDir>/app.config.ts`:
+
+```ts
+import { defineAppConfig } from '#imports';
+
+// Define types for your config
+declare module 'wxt/utils/define-app-config' {
+  export interface WxtAppConfig {
+    theme?: 'light' | 'dark';
+  }
+}
+
+export default defineAppConfig({
+  theme: 'dark',
+});
+```
+
+:::warning
+This file is committed to the repo, so don't put any secrets here. Instead, use [Environment Variables](#environment-variables)
+:::
+
+To access runtime config, WXT provides the `useAppConfig` function:
+
+```ts
+import { useAppConfig } from '#imports';
+
+console.log(useAppConfig()); // { theme: "dark" }
+```
+
+## Environment Variables in App Config
+
+You can use environment variables in the `app.config.ts` file.
+
+```ts
+declare module 'wxt/utils/define-app-config' {
+  export interface WxtAppConfig {
+    apiKey?: string;
+    skipWelcome: boolean;
+  }
+}
+
+export default defineAppConfig({
+  apiKey: import.meta.env.WXT_API_KEY,
+  skipWelcome: import.meta.env.WXT_SKIP_WELCOME === 'true',
+});
+```
+
+This has several advantages:
+
+- Define all expected environment variables in a single file
+- Convert strings to other types, like booleans or arrays
+- Provide default values if an environment variable is not provided

docs/guide/essentials/config/typescript.md

@@ -0,0 +1,65 @@
+# TypeScript Configuration
+
+When you run [`wxt prepare`](/api/cli/wxt-prepare), WXT generates a base TSConfig file for your project at `<rootDir>/.wxt/tsconfig.json`.
+
+At a minimum, you need to create a TSConfig in your root directory that looks like this:
+
+```jsonc
+// <rootDir>/tsconfig.json
+{
+  "extends": ".wxt/tsconfig.json",
+}
+```
+
+Or if you're in a monorepo, you may not want to extend the config. If you don't extend it, you need to add `.wxt/wxt.d.ts` to the TypeScript project:
+
+```ts
+/// <reference path="./.wxt/wxt.d.ts" />
+```
+
+## Compiler Options
+
+To specify custom compiler options, add them in `<rootDir>/tsconfig.json`:
+
+```jsonc
+// <rootDir>/tsconfig.json
+{
+  "extends": ".wxt/tsconfig.json",
+  "compilerOptions": {
+    "jsx": "preserve",
+  },
+}
+```
+
+## TSConfig Paths
+
+WXT provides a default set of path aliases.
+
+| Alias | To            | Example                                         |
+| ----- | ------------- | ----------------------------------------------- |
+| `~~`  | `<rootDir>/*` | `import "~~/scripts"`                           |
+| `@@`  | `<rootDir>/*` | `import "@@/scripts"`                           |
+| `~`   | `<srcDir>/*`  | `import { toLowerCase } from "~/utils/strings"` |
+| `@`   | `<srcDir>/*`  | `import { toLowerCase } from "@/utils/strings"` |
+
+To add your own, DO NOT add them to your `tsconfig.json`! Instead, use the [`alias` option](/api/reference/wxt/interfaces/InlineConfig#alias) in `wxt.config.ts`.
+
+This will add your custom aliases to `<rootDir>/.wxt/tsconfig.json` next time you run `wxt prepare`. It also adds your alias to the bundler so it can resolve imports.
+
+```ts
+import { resolve } from 'node:path';
+
+export default defineConfig({
+  alias: {
+    // Directory:
+    testing: resolve('utils/testing'),
+    // File:
+    strings: resolve('utils/strings.ts'),
+  },
+});
+```
+
+```ts
+import { fakeTab } from 'testing/fake-objects';
+import { toLowerCase } from 'strings';
+```

docs/guide/essentials/config/vite.md

@@ -0,0 +1,65 @@
+# Vite
+
+WXT uses [Vite](https://vitejs.dev/) under the hood to bundle your extension.
+
+This page explains how to customize your project's Vite config. Refer to [Vite's documentation](https://vite.dev/config/) to learn more about configuring the bundler.
+
+:::tip
+In most cases, you shouldn't change Vite's build settings. WXT provides sensible defaults that output a valid extension accepted by all stores when publishing.
+:::
+
+## Change Vite Config
+
+You can change Vite's config via the `wxt.config.ts` file:
+
+```ts [wxt.config.ts]
+import { defineConfig } from 'wxt';
+
+export default defineConfig({
+  vite: () => ({
+    // Override config here, same as `defineConfig({ ... })`
+    // inside vite.config.ts files
+  }),
+});
+```
+
+## Add Vite Plugins
+
+To add a plugin, install the NPM package and add it to the Vite config:
+
+```ts [wxt.config.ts]
+import { defineConfig } from 'wxt';
+import VueRouter from 'unplugin-vue-router/vite';
+
+export default defineConfig({
+  vite: () => ({
+    plugins: [
+      VueRouter({
+        /* ... */
+      }),
+    ],
+  }),
+});
+```
+
+:::warning
+Due to the way WXT orchestrates Vite builds, some plugins may not work as expected. For example, `vite-plugin-remove-console` normally only runs when you build for production (`vite build`). However, WXT uses a combination of dev server and builds during development, so you need to manually tell it when to run:
+
+```ts [wxt.config.ts]
+import { defineConfig } from 'wxt';
+import removeConsole from 'vite-plugin-remove-console';
+
+export default defineConfig({
+  vite: (configEnv) => ({
+    plugins:
+      configEnv.mode === 'production'
+        ? [removeConsole({ includes: ['log'] })]
+        : [],
+  }),
+});
+```
+
+Search [GitHub issues](https://github.com/wxt-dev/wxt/issues?q=is%3Aissue+label%3A%22vite+plugin%22) if you run into issues with a specific plugin.
+
+If an issue doesn't exist for your plugin, [open a new one](https://github.com/wxt-dev/wxt/issues/new/choose).
+:::

docs/guide/essentials/content-scripts.md

@@ -0,0 +1,666 @@
+---
+outline: deep
+---
+
+# Content Scripts
+
+> To create a content script, see [Entrypoint Types](/guide/essentials/entrypoints#content-scripts).
+
+## Context
+
+The first argument to a content script's `main` function is its "context".
+
+```ts
+// entrypoints/example.content.ts
+export default defineContentScript({
+  main(ctx) {},
+});
+```
+
+This object is responsible for tracking whether or not the content script's context is "invalidated". Most browsers, by default, do not stop content scripts if the extension is uninstalled, updated, or disabled. When this happens, content scripts start reporting this error:
+
+```
+Error: Extension context invalidated.
+```
+
+The `ctx` object provides several helpers to stop asynchronous code from running once the context is invalidated:
+
+```ts
+ctx.addEventListener(...);
+ctx.setTimeout(...);
+ctx.setInterval(...);
+ctx.requestAnimationFrame(...);
+// and more
+```
+
+You can also check if the context is invalidated manually:
+
+```ts
+if (ctx.isValid) {
+  // do something
+}
+// OR
+if (ctx.isInvalid) {
+  // do something
+}
+```
+
+## CSS
+
+In regular web extensions, CSS for content scripts is usually a separate CSS file, that is added to a CSS array in the manifest:
+
+```json
+{
+  "content_scripts": [
+    {
+      "css": ["content/style.css"],
+      "js": ["content/index.js"],
+      "matches": ["*://*/*"]
+    }
+  ]
+}
+```
+
+In WXT, to add CSS to a content script, simply import the CSS file into your JS entrypoint, and WXT will automatically add the bundled CSS output to the `css` array.
+
+```ts
+// entrypoints/example.content/index.ts
+import './style.css';
+
+export default defineContentScript({
+  // ...
+});
+```
+
+To create a standalone content script that only includes a CSS file:
+
+1. Create the CSS file: `entrypoints/example.content.css`
+2. Use the `build:manifestGenerated` hook to add the content script to the manifest:
+   ```ts [wxt.config.ts]
+   export default defineConfig({
+     hooks: {
+       'build:manifestGenerated': (wxt, manifest) => {
+         manifest.content_scripts ??= [];
+         manifest.content_scripts.push({
+           // Build extension once to see where your CSS get's written to
+           css: ['content-scripts/example.css'],
+           matches: ['*://*/*'],
+         });
+       },
+     },
+   });
+   ```
+
+## UI
+
+WXT provides 3 built-in utilities for adding UIs to a page from a content script:
+
+- [Integrated](#integrated) - `createIntegratedUi`
+- [Shadow Root](#shadow-root) -`createShadowRootUi`
+- [IFrame](#iframe) - `createIframeUi`
+
+Each has their own set of advantages and disadvantages.
+
+| Method      | Isolated Styles |   Isolated Events   | HMR | Use page's context |
+| ----------- | :-------------: | :-----------------: | :-: | :----------------: |
+| Integrated  |       ❌        |         ❌          | ❌  |         ✅         |
+| Shadow Root |       ✅        | ✅ (off by default) | ❌  |         ✅         |
+| IFrame      |       ✅        |         ✅          | ✅  |         ❌         |
+
+### Integrated
+
+Integrated content script UIs are injected alongside the content of a page. This means that they are affected by CSS on that page.
+
+:::code-group
+
+```ts [Vanilla]
+// entrypoints/example-ui.content.ts
+export default defineContentScript({
+  matches: ['<all_urls>'],
+
+  main(ctx) {
+    const ui = createIntegratedUi(ctx, {
+      position: 'inline',
+      anchor: 'body',
+      onMount: (container) => {
+        // Append children to the container
+        const app = document.createElement('p');
+        app.textContent = '...';
+        container.append(app);
+      },
+    });
+
+    // Call mount to add the UI to the DOM
+    ui.mount();
+  },
+});
+```
+
+```ts [Vue]
+// entrypoints/example-ui.content/index.ts
+import { createApp } from 'vue';
+import App from './App.vue';
+
+export default defineContentScript({
+  matches: ['<all_urls>'],
+
+  main(ctx) {
+    const ui = createIntegratedUi(ctx, {
+      position: 'inline',
+      anchor: 'body',
+      onMount: (container) => {
+        // Create the app and mount it to the UI container
+        const app = createApp(App);
+        app.mount(container);
+        return app;
+      },
+      onRemove: (app) => {
+        // Unmount the app when the UI is removed
+        app.unmount();
+      },
+    });
+
+    // Call mount to add the UI to the DOM
+    ui.mount();
+  },
+});
+```
+
+```tsx [React]
+// entrypoints/example-ui.content/index.tsx
+import ReactDOM from 'react-dom/client';
+import App from './App.tsx';
+
+export default defineContentScript({
+  matches: ['<all_urls>'],
+
+  main(ctx) {
+    const ui = createIntegratedUi(ctx, {
+      position: 'inline',
+      anchor: 'body',
+      onMount: (container) => {
+        // Create a root on the UI container and render a component
+        const root = ReactDOM.createRoot(container);
+        root.render(<App />);
+        return root;
+      },
+      onRemove: (root) => {
+        // Unmount the root when the UI is removed
+        root.unmount();
+      },
+    });
+
+    // Call mount to add the UI to the DOM
+    ui.mount();
+  },
+});
+```
+
+```ts [Svelte]
+// entrypoints/example-ui.content/index.ts
+import App from './App.svelte';
+import { mount, unmount } from 'svelte';
+
+export default defineContentScript({
+  matches: ['<all_urls>'],
+
+  main(ctx) {
+    const ui = createIntegratedUi(ctx, {
+      position: 'inline',
+      anchor: 'body',
+      onMount: (container) => {
+        // Create the Svelte app inside the UI container
+        mount(App, {
+          target: container,
+        });
+      },
+      onRemove: (app) => {
+        // Destroy the app when the UI is removed
+        unmount(app);
+      },
+    });
+
+    // Call mount to add the UI to the DOM
+    ui.mount();
+  },
+});
+```
+
+```tsx [Solid]
+// entrypoints/example-ui.content/index.ts
+import { render } from 'solid-js/web';
+
+export default defineContentScript({
+  matches: ['<all_urls>'],
+
+  main(ctx) {
+    const ui = createIntegratedUi(ctx, {
+      position: 'inline',
+      anchor: 'body',
+      onMount: (container) => {
+        // Render your app to the UI container
+        const unmount = render(() => <div>...</div>, container);
+        return unmount;
+      },
+      onRemove: (unmount) => {
+        // Unmount the app when the UI is removed
+        unmount();
+      },
+    });
+
+    // Call mount to add the UI to the DOM
+    ui.mount();
+  },
+});
+```
+
+:::
+
+See the [API Reference](/api/reference/wxt/utils/content-script-ui/integrated/functions/createIntegratedUi) for the complete list of options.
+
+### Shadow Root
+
+Often in web extensions, you don't want your content script's CSS affecting the page, or vise-versa. The [`ShadowRoot`](https://developer.mozilla.org/en-US/docs/Web/API/ShadowRoot) API is ideal for this.
+
+WXT's [`createShadowRootUi`](/api/reference/wxt/utils/content-script-ui/shadow-root/functions/createShadowRootUi) abstracts all the `ShadowRoot` setup away, making it easy to create UIs whose styles are isolated from the page. It also supports an optional `isolateEvents` parameter to further isolate user interactions.
+
+To use `createShadowRootUi`, follow these steps:
+
+1. Import your CSS file at the top of your content script
+2. Set [`cssInjectionMode: "ui"`](/api/reference/wxt/interfaces/BaseContentScriptEntrypointOptions#cssinjectionmode) inside `defineContentScript`
+3. Define your UI with `createShadowRootUi()`
+4. Mount the UI so it is visible to users
+
+:::code-group
+
+```ts [Vanilla]
+// 1. Import the style
+import './style.css';
+
+export default defineContentScript({
+  matches: ['<all_urls>'],
+  // 2. Set cssInjectionMode
+  cssInjectionMode: 'ui',
+
+  async main(ctx) {
+    // 3. Define your UI
+    const ui = await createShadowRootUi(ctx, {
+      name: 'example-ui',
+      position: 'inline',
+      anchor: 'body',
+      onMount(container) {
+        // Define how your UI will be mounted inside the container
+        const app = document.createElement('p');
+        app.textContent = 'Hello world!';
+        container.append(app);
+      },
+    });
+
+    // 4. Mount the UI
+    ui.mount();
+  },
+});
+```
+
+```ts [Vue]
+// 1. Import the style
+import './style.css';
+import { createApp } from 'vue';
+import App from './App.vue';
+
+export default defineContentScript({
+  matches: ['<all_urls>'],
+  // 2. Set cssInjectionMode
+  cssInjectionMode: 'ui',
+
+  async main(ctx) {
+    // 3. Define your UI
+    const ui = await createShadowRootUi(ctx, {
+      name: 'example-ui',
+      position: 'inline',
+      anchor: 'body',
+      onMount: (container) => {
+        // Define how your UI will be mounted inside the container
+        const app = createApp(App);
+        app.mount(container);
+        return app;
+      },
+      onRemove: (app) => {
+        // Unmount the app when the UI is removed
+        app?.unmount();
+      },
+    });
+
+    // 4. Mount the UI
+    ui.mount();
+  },
+});
+```
+
+```tsx [React]
+// 1. Import the style
+import './style.css';
+import ReactDOM from 'react-dom/client';
+import App from './App.tsx';
+
+export default defineContentScript({
+  matches: ['<all_urls>'],
+  // 2. Set cssInjectionMode
+  cssInjectionMode: 'ui',
+
+  async main(ctx) {
+    // 3. Define your UI
+    const ui = await createShadowRootUi(ctx, {
+      name: 'example-ui',
+      position: 'inline',
+      anchor: 'body',
+      onMount: (container) => {
+        // Container is a body, and React warns when creating a root on the body, so create a wrapper div
+        const app = document.createElement('div');
+        container.append(app);
+
+        // Create a root on the UI container and render a component
+        const root = ReactDOM.createRoot(app);
+        root.render(<App />);
+        return root;
+      },
+      onRemove: (root) => {
+        // Unmount the root when the UI is removed
+        root?.unmount();
+      },
+    });
+
+    // 4. Mount the UI
+    ui.mount();
+  },
+});
+```
+
+```ts [Svelte]
+// 1. Import the style
+import './style.css';
+import App from './App.svelte';
+import { mount, unmount } from 'svelte';
+
+export default defineContentScript({
+  matches: ['<all_urls>'],
+  // 2. Set cssInjectionMode
+  cssInjectionMode: 'ui',
+
+  async main(ctx) {
+    // 3. Define your UI
+    const ui = await createShadowRootUi(ctx, {
+      name: 'example-ui',
+      position: 'inline',
+      anchor: 'body',
+      onMount: (container) => {
+        // Create the Svelte app inside the UI container
+        mount(App, {
+          target: container,
+        });
+      },
+      onRemove: () => {
+        // Destroy the app when the UI is removed
+        unmount(app);
+      },
+    });
+
+    // 4. Mount the UI
+    ui.mount();
+  },
+});
+```
+
+```tsx [Solid]
+// 1. Import the style
+import './style.css';
+import { render } from 'solid-js/web';
+
+export default defineContentScript({
+  matches: ['<all_urls>'],
+  // 2. Set cssInjectionMode
+  cssInjectionMode: 'ui',
+
+  async main(ctx) {
+    // 3. Define your UI
+    const ui = await createShadowRootUi(ctx, {
+      name: 'example-ui',
+      position: 'inline',
+      anchor: 'body',
+      onMount: (container) => {
+        // Render your app to the UI container
+        const unmount = render(() => <div>...</div>, container);
+      },
+      onRemove: (unmount) => {
+        // Unmount the app when the UI is removed
+        unmount?.();
+      },
+    });
+
+    // 4. Mount the UI
+    ui.mount();
+  },
+});
+```
+
+:::
+
+See the [API Reference](/api/reference/wxt/utils/content-script-ui/shadow-root/functions/createShadowRootUi) for the complete list of options.
+
+Full examples:
+
+- [react-content-script-ui](https://github.com/wxt-dev/examples/tree/main/examples/react-content-script-ui)
+- [tailwindcss](https://github.com/wxt-dev/examples/tree/main/examples/tailwindcss)
+
+### IFrame
+
+If you don't need to run your UI in the same frame as the content script, you can use an IFrame to host your UI instead. Since an IFrame just hosts an HTML page, **_HMR is supported_**.
+
+WXT provides a helper function, [`createIframeUi`](/api/reference/wxt/utils/content-script-ui/iframe/functions/createIframeUi), which simplifies setting up the IFrame.
+
+1. Create an HTML page that will be loaded into your IFrame:
+   ```html
+   <!-- entrypoints/example-iframe.html -->
+   <!doctype html>
+   <html lang="en">
+     <head>
+       <meta charset="UTF-8" />
+       <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+       <title>Your Content Script IFrame</title>
+     </head>
+     <body>
+       <!-- ... -->
+     </body>
+   </html>
+   ```
+1. Add the page to the manifest's `web_accessible_resources`:
+   ```ts [wxt.config.ts]
+   export default defineConfig({
+     manifest: {
+       web_accessible_resources: [
+         {
+           resources: ['example-iframe.html'],
+           matches: [...],
+         },
+       ],
+     },
+   });
+   ```
+1. Create and mount the IFrame:
+
+   ```ts
+   export default defineContentScript({
+     matches: ['<all_urls>'],
+
+     main(ctx) {
+       // Define the UI
+       const ui = createIframeUi(ctx, {
+         page: '/example-iframe.html',
+         position: 'inline',
+         anchor: 'body',
+         onMount: (wrapper, iframe) => {
+           // Add styles to the iframe like width
+           iframe.width = '123';
+         },
+       });
+
+       // Show UI to user
+       ui.mount();
+     },
+   });
+   ```
+
+See the [API Reference](/api/reference/wxt/utils/content-script-ui/iframe/functions/createIframeUi) for the complete list of options.
+
+## Isolated World vs Main World
+
+By default, all content scripts run in an isolated context where only the DOM is shared with the webpage it is running on - an "isolated world". In MV3, Chromium introduced the ability to run content scripts in the "main" world - where everything, not just the DOM, is available to the content script, just like if the script were loaded by the webpage.
+
+You can enable this for a content script by setting the `world` option:
+
+```ts
+export default defineContentScript({
+  world: 'MAIN',
+});
+```
+
+However, this approach has several notable drawbacks:
+
+- Doesn't support MV2
+- `world: "MAIN"` is only supported by Chromium browsers
+- Main world content scripts don't have access to the extension API
+
+Instead, WXT recommends injecting a script into the main world manually using it's `injectScript` function. This will address the drawbacks mentioned before.
+
+- `injectScript` supports both MV2 and MV3
+- `injectScript` supports all browsers
+- Having a "parent" content script means you can send messages back and forth, making it possible to access the extension API
+
+To use `injectScript`, we need two entrypoints, one content script and one unlisted script:
+
+<!-- prettier-ignore -->
+```html
+📂 entrypoints/
+   📄 example.content.ts
+   📄 example-main-world.ts
+```
+
+```ts
+// entrypoints/example-main-world.ts
+export default defineUnlistedScript(() => {
+  console.log('Hello from the main world');
+});
+```
+
+```ts
+// entrypoints/example.content.ts
+export default defineContentScript({
+  matches: ['*://*/*'],
+  async main() {
+    console.log('Injecting script...');
+    await injectScript('/example-main-world.js', {
+      keepInDom: true,
+    });
+    console.log('Done!');
+  },
+});
+```
+
+```json
+export default defineConfig({
+  manifest: {
+    // ...
+    web_accessible_resources: [
+      {
+        resources: ["example-main-world.js"],
+        matches: ["*://*/*"],
+      }
+    ]
+  }
+});
+```
+
+`injectScript` works by creating a `script` element on the page pointing to your script. This loads the script into the page's context so it runs in the main world.
+
+`injectScript` returns a promise, that when resolved, means the script has been evaluated by the browser and you can start communicating with it.
+
+:::warning Warning: `run_at` Caveat
+For MV3, `injectScript` is synchronous and the injected script will be evaluated at the same time as your the content script's `run_at`.
+
+However for MV2, `injectScript` has to `fetch` the script's text content and create an inline `<script>` block. This means for MV2, your script is injected asynchronously and it will not be evaluated at the same time as your content script's `run_at`.
+:::
+
+## Mounting UI to dynamic element
+
+In many cases, you may need to mount a UI to a DOM element that does not exist at the time the web page is initially loaded. To handle this, use the `autoMount` API to automatically mount the UI when the target element appears dynamically and unmount it when the element disappears. In WXT, the `anchor` option is used to target the element, enabling automatic mounting and unmounting based on its appearance and removal.
+
+```ts
+export default defineContentScript({
+  matches: ['<all_urls>'],
+
+  main(ctx) {
+    const ui = createIntegratedUi(ctx, {
+      position: 'inline',
+      // It observes the anchor
+      anchor: '#your-target-dynamic-element',
+      onMount: (container) => {
+        // Append children to the container
+        const app = document.createElement('p');
+        app.textContent = '...';
+        container.append(app);
+      },
+    });
+
+    // Call autoMount to observe anchor element for add/remove.
+    ui.autoMount();
+  },
+});
+```
+
+:::tip
+When the `ui.remove` is called, `autoMount` also stops.
+:::
+
+See the [API Reference](/api/reference/wxt/utils/content-script-ui/types/interfaces/ContentScriptUi#automount) for the complete list of options.
+
+## Dealing with SPAs
+
+It is difficult to write content scripts for SPAs (single page applications) and websites using HTML5 history mode for navigation because content scripts are only ran on full page reloads. SPAs and websites that take advantage of HTML5 history mode **_do not perform a full reload when changing paths_**, and thus your content script isn't going to be ran when you expect it to be.
+
+Let's look at an example. Say you want to add a UI to YouTube when watching a video:
+
+```ts
+export default defineContentScript({
+  matches: ['*://*.youtube.com/watch*'],
+  main(ctx) {
+    console.log('YouTube content script loaded');
+
+    mountUi(ctx);
+  },
+});
+
+function mountUi(ctx: ContentScriptContext): void {
+  // ...
+}
+```
+
+You're only going to see "YouTube content script loaded" when reloading the watch page or when navigating directly to it from another website.
+
+To get around this, you'll need to manually listen for the path to change and run your content script when the URL matches what you expect it to match.
+
+```ts
+const watchPattern = new MatchPattern('*://*.youtube.com/watch*');
+
+export default defineContentScript({
+  matches: ['*://*.youtube.com/*'],
+  main(ctx) {
+    ctx.addEventListener(window, 'wxt:locationchange', ({ newUrl }) => {
+      if (watchPattern.includes(newUrl)) mainWatch(ctx);
+    });
+  },
+});
+
+function mainWatch(ctx: ContentScriptContext) {
+  mountUi(ctx);
+}
+```

docs/guide/essentials/e2e-testing.md

@@ -0,0 +1,9 @@
+# E2E Testing
+
+## Playwright
+
+[Playwright](https://playwright.dev) is the only good option for writing Chrome Extension end-to-end tests.
+
+To add E2E tests to your project, follow Playwright's [Chrome Extension docs](https://playwright.dev/docs/chrome-extensions). When you have to pass the path to your extension, pass the output directory, `/path/to/project/.output/chrome-mv3`.
+
+For a complete example, see the [WXT's Playwright Example](https://github.com/wxt-dev/examples/tree/main/examples/playwright-e2e-testing).

docs/guide/essentials/entrypoints.md

@@ -0,0 +1,555 @@
+---
+outline: deep
+---
+
+# Entrypoints
+
+WXT uses the files inside the `entrypoints/` directory as inputs when bundling your extension. They can be HTML, JS, CSS, or any variant of those file types supported by Vite (Pug, TS, JSX, SCSS, etc).
+
+Here's an example set of entrypoints:
+
+<!-- prettier-ignore -->
+```html
+📂 entrypoints/
+   📂 popup/
+      📄 index.html
+      📄 main.ts
+      📄 style.css
+   📄 background.ts
+   📄 content.ts
+```
+
+[[toc]]
+
+## Listed vs Unlisted
+
+For web extensions, there are two types of entrypoints:
+
+- **Listed**: Referenced in the `manifest.json`
+- **Unlisted**: Not referenced in the `manifest.json`
+
+Throughout the rest of WXT's documentation, listed entrypoints are referred to by name. For example:
+
+- Popup
+- Options
+- Background
+- Content Scripts
+- Etc.
+
+Some examples of "unlisted" entrypoints:
+
+- A welcome page shown when the extension is installed
+- JS files injected by content scripts into the page's main world
+
+:::tip
+Regardless of whether an entrypoint is listed or unlisted, it will still be bundled into your extension and be available at runtime.
+:::
+
+## Adding Entrypoints
+
+An entrypoint can be defined as a single file or directory with an `index` file inside it.
+
+:::code-group
+
+<!-- prettier-ignore -->
+```html [Single File]
+📂 entrypoints/
+   📄 background.ts
+```
+
+<!-- prettier-ignore -->
+```html [Directory]
+📂 entrypoints/
+   📂 background/
+      📄 index.ts
+```
+
+:::
+
+The entrypoint's name dictates the type of entrypoint, listed vs unlisted. In this example, "background" is the name of the ["Background" entrypoint](#background).
+
+Refer to the [Entrypoint Types](#entrypoint-types) section for the full list of listed entrypoints and their filename patterns.
+
+## Defining Manifest Options
+
+Most listed entrypoints have options that need to be added to the `manifest.json`. However with WXT, instead of defining the options in a separate file, _you define these options inside the entrypoint file itself_.
+
+For example, here's how to define `matches` for content scripts:
+
+```ts [entrypoints/content.ts]
+export default defineContentScript({
+  matches: ['*://*.wxt.dev/*'],
+  main() {
+    // ...
+  },
+});
+```
+
+For HTML entrypoints, options are configured as `<meta>` tags. For example, to use a `page_action` for your MV2 popup:
+
+```html
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta name="manifest.type" content="page_action" />
+  </head>
+</html>
+```
+
+> Refer to the [Entrypoint Types](#entrypoint-types) sections for a list of options configurable inside each entrypoint, and how to define them.
+
+When building your extension, WXT will look at the options defined in your entrypoints, and generate the manifest accordingly.
+
+## Entrypoint Types
+
+### Background
+
+[Chrome Docs](https://developer.chrome.com/docs/extensions/mv3/manifest/background/) &bull; [Firefox Docs](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/background)
+
+For MV2, the background is added as a script to the background page. For MV3, the background becomes a service worker.
+
+<EntrypointPatterns
+  :patterns="[
+    ['background.[jt]s', 'background.js'],
+    ['background/index.[jt]s', 'background.js'],
+  ]"
+/>
+
+:::code-group
+
+```ts [Minimal]
+export default defineBackground(() => {
+  // Executed when background is loaded
+});
+```
+
+```ts [With Manifest Options]
+export default defineBackground({
+  // Set manifest options
+  persistent: undefined | true | false,
+  type: undefined | 'module',
+
+  // Set include/exclude if the background should be removed from some builds
+  include: undefined | string[],
+  exclude: undefined | string[],
+
+  main() {
+    // Executed when background is loaded, CANNOT BE ASYNC
+  },
+});
+```
+
+:::
+
+### Bookmarks
+
+[Chrome Docs](https://developer.chrome.com/docs/extensions/mv3/override/) &bull; [Firefox Docs](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/chrome_url_overrides)
+
+<EntrypointPatterns
+  :patterns="[
+    ['bookmarks.html', 'bookmarks.html'],
+    ['bookmarks/index.html', 'bookmarks.html'],
+  ]"
+/>
+
+```html
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Title</title>
+    <!-- Set include/exclude if the page should be removed from some builds -->
+    <meta name="manifest.include" content="['chrome', ...]" />
+    <meta name="manifest.exclude" content="['chrome', ...]" />
+  </head>
+  <body>
+    <!-- ... -->
+  </body>
+</html>
+```
+
+### Content Scripts
+
+[Chrome Docs](https://developer.chrome.com/docs/extensions/mv3/content_scripts/) &bull; [Firefox Docs](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Content_scripts)
+
+See [Content Script UI](/guide/essentials/content-scripts) for more info on creating UIs and including CSS in content scripts.
+
+<EntrypointPatterns
+  :patterns="[
+    ['content.[jt]sx?', 'content-scripts/content.js'],
+    ['content/index.[jt]sx?', 'content-scripts/content.js'],
+    ['<name>.content.[jt]sx?', 'content-scripts/<name>.js'],
+    ['<name>.content/index.[jt]sx?', 'content-scripts/<name>.js'],
+  ]"
+/>
+
+```ts
+export default defineContentScript({
+  // Set manifest options
+  matches: string[],
+  excludeMatches: undefined | [],
+  includeGlobs: undefined | [],
+  excludeGlobs: undefined | [],
+  allFrames: undefined | true | false,
+  runAt: undefined | 'document_start' | 'document_end' | 'document_idle',
+  matchAboutBlank: undefined | true | false,
+  matchOriginAsFallback: undefined | true | false,
+  world: undefined | 'ISOLATED' | 'MAIN',
+
+  // Set include/exclude if the background should be removed from some builds
+  include: undefined | string[],
+  exclude: undefined | string[],
+
+  // Configure how CSS is injected onto the page
+  cssInjectionMode: undefined | "manifest" | "manual" | "ui",
+
+  // Configure how/when content script will be registered
+  registration: undefined | "manifest" | "runtime",
+
+  main(ctx: ContentScriptContext) {
+    // Executed when content script is loaded, can be async
+  },
+});
+```
+
+### Devtools
+
+[Chrome Docs](https://developer.chrome.com/docs/extensions/mv3/devtools/) &bull; [Firefox Docs](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/devtools_page)
+
+Follow the [Devtools Example](https://github.com/wxt-dev/examples/tree/main/examples/devtools-extension#readme) to add different panels and panes.
+
+<EntrypointPatterns
+  :patterns="[
+    ['devtools.html', 'devtools.html'],
+    ['devtools/index.html', 'devtools.html'],
+  ]"
+/>
+
+```html
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <!-- Set include/exclude if the page should be removed from some builds -->
+    <meta name="manifest.include" content="['chrome', ...]" />
+    <meta name="manifest.exclude" content="['chrome', ...]" />
+  </head>
+  <body>
+    <!-- ... -->
+  </body>
+</html>
+```
+
+### History
+
+[Chrome Docs](https://developer.chrome.com/docs/extensions/mv3/override/) &bull; [Firefox Docs](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/chrome_url_overrides)
+
+<EntrypointPatterns
+  :patterns="[
+    ['history.html', 'history.html'],
+    ['history/index.html', 'history.html'],
+  ]"
+/>
+
+```html
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Title</title>
+    <!-- Set include/exclude if the page should be removed from some builds -->
+    <meta name="manifest.include" content="['chrome', ...]" />
+    <meta name="manifest.exclude" content="['chrome', ...]" />
+  </head>
+  <body>
+    <!-- ... -->
+  </body>
+</html>
+```
+
+### Newtab
+
+[Chrome Docs](https://developer.chrome.com/docs/extensions/mv3/override/) &bull; [Firefox Docs](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/chrome_url_overrides)
+
+<EntrypointPatterns
+  :patterns="[
+    ['newtab.html', 'newtab.html'],
+    ['newtab/index.html', 'newtab.html'],
+  ]"
+/>
+
+```html
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Title</title>
+    <!-- Set include/exclude if the page should be removed from some builds -->
+    <meta name="manifest.include" content="['chrome', ...]" />
+    <meta name="manifest.exclude" content="['chrome', ...]" />
+  </head>
+  <body>
+    <!-- ... -->
+  </body>
+</html>
+```
+
+### Options
+
+[Chrome Docs](https://developer.chrome.com/docs/extensions/mv3/options/) &bull; [Firefox Docs](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/options_ui)
+
+<EntrypointPatterns
+  :patterns="[
+    ['options.html', 'options.html'],
+    ['options/index.html', 'options.html'],
+  ]"
+/>
+
+```html
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Options Title</title>
+
+    <!-- Customize the manifest options -->
+    <meta name="manifest.open_in_tab" content="true|false" />
+    <meta name="manifest.chrome_style" content="true|false" />
+    <meta name="manifest.browser_style" content="true|false" />
+
+    <!-- Set include/exclude if the page should be removed from some builds -->
+    <meta name="manifest.include" content="['chrome', ...]" />
+    <meta name="manifest.exclude" content="['chrome', ...]" />
+  </head>
+  <body>
+    <!-- ... -->
+  </body>
+</html>
+```
+
+### Popup
+
+[Chrome Docs](https://developer.chrome.com/docs/extensions/reference/action/) &bull; [Firefox Docs](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/action)
+
+<EntrypointPatterns
+  :patterns="[
+    ['popup.html', 'popup.html'],
+    ['popup/index.html', 'popup.html'],
+  ]"
+/>
+
+```html
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+
+    <!-- Set the `action.default_title` in the manifest -->
+    <title>Default Popup Title</title>
+
+    <!-- Customize the manifest options -->
+    <meta
+      name="manifest.default_icon"
+      content="{
+        16: '/icon-16.png',
+        24: '/icon-24.png',
+        ...
+      }"
+    />
+    <meta name="manifest.type" content="page_action|browser_action" />
+    <meta name="manifest.browser_style" content="true|false" />
+
+    <!-- Set include/exclude if the page should be removed from some builds -->
+    <meta name="manifest.include" content="['chrome', ...]" />
+    <meta name="manifest.exclude" content="['chrome', ...]" />
+  </head>
+  <body>
+    <!-- ... -->
+  </body>
+</html>
+```
+
+### Sandbox
+
+[Chrome Docs](https://developer.chrome.com/docs/extensions/mv3/manifest/sandbox/)
+
+:::warning Chromium Only
+Firefox does not support sandboxed pages.
+:::
+
+<EntrypointPatterns
+  :patterns="[
+    ['sandbox.html', 'sandbox.html'],
+    ['sandbox/index.html', 'sandbox.html'],
+    ['<name>.sandbox.html', '<name>.html'],
+    ['<name>.sandbox/index.html', '<name>.html'],
+  ]"
+/>
+
+```html
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Title</title>
+
+    <!-- Set include/exclude if the page should be removed from some builds -->
+    <meta name="manifest.include" content="['chrome', ...]" />
+    <meta name="manifest.exclude" content="['chrome', ...]" />
+  </head>
+  <body>
+    <!-- ... -->
+  </body>
+</html>
+```
+
+### Side Panel
+
+[Chrome Docs](https://developer.chrome.com/docs/extensions/reference/sidePanel/) &bull; [Firefox Docs](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/user_interface/Sidebars)
+
+In Chrome, side panels use the `side_panel` API, while Firefox uses the `sidebar_action` API.
+
+<EntrypointPatterns
+  :patterns="[
+    ['sidepanel.html', 'sidepanel.html'],
+    ['sidepanel/index.html', 'sidepanel.html'],
+    ['<name>.sidepanel.html', '<name>.html` '],
+    ['<name>.sidepanel/index.html', '<name>.html` '],
+  ]"
+/>
+
+```html
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Default Side Panel Title</title>
+
+    <!-- Customize the manifest options -->
+    <meta
+      name="manifest.default_icon"
+      content="{
+        16: '/icon-16.png',
+        24: '/icon-24.png',
+        ...
+      }"
+    />
+    <meta name="manifest.open_at_install" content="true|false" />
+    <meta name="manifest.browser_style" content="true|false" />
+
+    <!-- Set include/exclude if the page should be removed from some builds -->
+    <meta name="manifest.include" content="['chrome', ...]" />
+    <meta name="manifest.exclude" content="['chrome', ...]" />
+  </head>
+  <body>
+    <!-- ... -->
+  </body>
+</html>
+```
+
+### Unlisted CSS
+
+Follow Vite's guide to setup your preprocessor of choice: https://vitejs.dev/guide/features.html#css-pre-processors
+
+CSS entrypoints are always unlisted. To add CSS to a content script, see the [Content Script](/guide/essentials/content-scripts#css) docs.
+
+<EntrypointPatterns
+  :patterns="[
+    ['<name>.(css|scss|sass|less|styl|stylus)', '<name>.css'],
+    ['<name>/index.(css|scss|sass|less|styl|stylus)', '<name>.css'],
+    ['content.(css|scss|sass|less|styl|stylus)', 'content-scripts/content.css'],
+    ['content/index.(css|scss|sass|less|styl|stylus)', 'content-scripts/content.css'],
+    ['<name>.content.(css|scss|sass|less|styl|stylus)', 'content-scripts/<name>.css'],
+    ['<name>.content/index.(css|scss|sass|less|styl|stylus)', 'content-scripts/<name>.css'],
+  ]"
+/>
+
+```css
+body {
+  /* ... */
+}
+```
+
+### Unlisted Pages
+
+<EntrypointPatterns
+  :patterns="[
+    ['<name>.html', '<name>.html'],
+    ['<name>/index.html', '<name>.html'],
+  ]"
+/>
+
+```html
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Title</title>
+
+    <!-- Set include/exclude if the page should be removed from some builds -->
+    <meta name="manifest.include" content="['chrome', ...]" />
+    <meta name="manifest.exclude" content="['chrome', ...]" />
+  </head>
+  <body>
+    <!-- ... -->
+  </body>
+</html>
+```
+
+Pages are accessible at `/<name>.html`:
+
+```ts
+const url = browser.runtime.getURL('/<name>.html');
+
+console.log(url); // "chrome-extension://<id>/<name>.html"
+```
+
+### Unlisted Scripts
+
+<EntrypointPatterns
+  :patterns="[
+    ['<name>.[jt]sx?', '<name>.js'],
+    ['<name>/index.[jt]sx?', '<name>.js'],
+  ]"
+/>
+
+:::code-group
+
+```ts [Minimal]
+export default defineUnlistedScript(() => {
+  // Executed when script is loaded
+});
+```
+
+```ts [With Options]
+export default defineUnlistedScript({
+  // Set include/exclude if the script should be removed from some builds
+  include: undefined | string[],
+  exclude: undefined | string[],
+
+  main() {
+    // Executed when script is loaded
+  },
+});
+```
+
+:::
+
+Scripts are accessible from `/<name>.js`:
+
+```ts
+const url = browser.runtime.getURL('/<name>.js');
+
+console.log(url); // "chrome-extension://<id>/<name>.js"
+```
+
+You are responsible for loading/running these scripts where needed. If necessary, don't forget to add the script and/or any related assets to [`web_accessible_resources`](https://developer.chrome.com/docs/extensions/reference/manifest/web-accessible-resources).

docs/guide/essentials/es-modules.md

@@ -0,0 +1,38 @@
+# ES Modules
+
+You source code should always be written as ESM. However, you have some control whether an entrypoint is bundled as ESM.
+
+## HTML Pages <Badge type="warning" text="≥0.0.1" />
+
+Vite only supports bundling JS from HTML pages as ESM. Ensure you have added `type="module"` to your `<script>` tags:
+
+<!-- prettier-ignore -->
+```html
+<script src="./main.ts"></script> <!-- [!code --] -->
+<script src="./main.ts" type="module"></script> <!-- [!code ++] -->
+```
+
+## Background <Badge type="warning" text="≥0.16.0" />
+
+By default, your background will be bundled into a single file as IIFE. You can change this by setting `type: "module"` in your background entrypoint:
+
+```ts
+export default defineBackground({
+  type: 'module', // [!code ++]
+  main() {
+    // ...
+  },
+});
+```
+
+This will change the output format to ESM, enable code-spliting between your background script and HTML pages, and set `"type": "module"` in your manifest.
+
+:::warning
+Only MV3 supports ESM background scripts/service workers. When targeting MV2, the `type` option is ignored and the background is always bundled into a single file as IIFE.
+:::
+
+## Content Scripts
+
+WXT does not yet include built-in support for bundling content scripts as ESM. The plan is to add support for chunking to reduce bundle size, but not support HMR for now. There are several technical issues that make implementing a generic solution for HMR impossible. See [Content Script ESM Support #357](https://github.com/wxt-dev/wxt/issues/357) for details.
+
+If you can't wait, and need ESM support right now, you can implement ESM support manually. See the [ESM Content Script UI](https://github.com/wxt-dev/examples/tree/main/examples/esm-content-script-ui) example to learn how.

docs/guide/essentials/extension-apis.md

@@ -0,0 +1,77 @@
+# Extension APIs
+
+[Chrome Docs](https://developer.chrome.com/docs/extensions/reference/api) • [Firefox Docs](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Browser_support_for_JavaScript_APIs)
+
+Different browsers provide different global variables for accessing the extension APIs (chrome provides `chrome`, firefox provides `browser`, etc).
+
+WXT merges these two into a unified API accessed through the `browser` variable.
+
+```ts
+import { browser } from 'wxt/browser';
+
+browser.action.onClicked.addListener(() => {
+  // ...
+});
+```
+
+:::tip
+With auto-imports enabled, you don't even need to import this variable from `wxt/browser`!
+:::
+
+The `browser` variable WXT provides is a simple export of the `browser` or `chrome` globals provided by the browser at runtime:
+
+<<< @/../packages/browser/src/index.mjs#snippet
+
+This means you can use the promise-style API for both MV2 and MV3, and it will work across all browsers (Chromium, Firefox, Safari, etc).
+
+## Accessing Types
+
+All types can be accessed via WXT's `Browser` namespace:
+
+```ts
+import { Browser } from 'wxt/browser';
+
+function handleMessage(message: any, sender: Browser.runtime.MessageSender) {
+  // ...
+}
+```
+
+## Using `webextension-polyfill`
+
+If you want to use the `webextension-polyfill` when importing `browser`, you can do so by installing the `@wxt-dev/webextension-polyfill` package.
+
+See it's [Installation Guide](https://github.com/wxt-dev/wxt/blob/main/packages/webextension-polyfill/README.md) to get started.
+
+## Feature Detection
+
+Depending on the manifest version, browser, and permissions, some APIs are not available at runtime. If an API is not available, it will be `undefined`.
+
+:::warning
+Types will not help you here. The types WXT provides for `browser` assume all APIs exist. You are responsible for knowing whether an API is available or not.
+:::
+
+To check if an API is available, use feature detection:
+
+```ts
+if (browser.runtime.onSuspend != null) {
+  browser.runtime.onSuspend.addListener(() => {
+    // ...
+  });
+}
+```
+
+Here, [optional chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Optional_chaining) is your best friend:
+
+```ts
+browser.runtime.onSuspend?.addListener(() => {
+  // ...
+});
+```
+
+Alternatively, if you're trying to use similar APIs under different names (to support MV2 and MV3), you can do something like this:
+
+```ts
+(browser.action ?? browser.browser_action).onClicked.addListener(() => {
+  //
+});
+```

docs/guide/essentials/frontend-frameworks.md

@@ -0,0 +1,103 @@
+# Frontend Frameworks
+
+## Built-in Modules
+
+WXT has preconfigured modules for the most popular frontend frameworks:
+
+- [`@wxt-dev/module-react`](https://github.com/wxt-dev/wxt/tree/main/packages/module-react)
+- [`@wxt-dev/module-vue`](https://github.com/wxt-dev/wxt/tree/main/packages/module-vue)
+- [`@wxt-dev/module-svelte`](https://github.com/wxt-dev/wxt/tree/main/packages/module-svelte)
+- [`@wxt-dev/module-solid`](https://github.com/wxt-dev/wxt/tree/main/packages/module-solid)
+
+Install the module for your framework, then add it to your config:
+
+:::code-group
+
+```ts [React]
+import { defineConfig } from 'wxt';
+
+export default defineConfig({
+  modules: ['@wxt-dev/module-react'],
+});
+```
+
+```ts [Vue]
+import { defineConfig } from 'wxt';
+
+export default defineConfig({
+  modules: ['@wxt-dev/module-vue'],
+});
+```
+
+```ts [Svelte]
+import { defineConfig } from 'wxt';
+
+export default defineConfig({
+  modules: ['@wxt-dev/module-svelte'],
+});
+```
+
+```ts [Solid]
+import { defineConfig } from 'wxt';
+
+export default defineConfig({
+  modules: ['@wxt-dev/module-solid'],
+});
+```
+
+:::
+
+## Adding Vite Plugins
+
+If your framework doesn't have an official WXT module, no worries! WXT supports any framework with a Vite plugin.
+
+Just add the Vite plugin to your config and you're good to go! Use the framework in HTML pages or content scripts and it will just work 👍
+
+```ts
+import { defineConfig } from 'wxt';
+import react from '@vitejs/plugin-react';
+
+export default defineConfig({
+  vite: () => ({
+    plugins: [react()],
+  }),
+});
+```
+
+> The WXT modules just simplify the configuration and add auto-imports. They're not much different than the above.
+
+## Multiple Apps
+
+Since web extensions usually contain multiple UIs across multiple entrypoints (popup, options, changelog, side panel, content scripts, etc), you'll need to create individual app instances, one per entrypoint.
+
+Usually, this means each entrypoint should be a directory with it's own files inside it. Here's the recommended folder structure:
+
+<!-- prettier-ignore -->
+```html
+📂 {srcDir}/
+   📂 assets/          <---------- Put shared assets here
+      📄 tailwind.css
+   📂 components/
+      📄 Button.tsx
+   📂 entrypoints/
+      📂 options/       <--------- Use a folder with an index.html file in it
+         📁 pages/      <--------- A good place to put your router pages if you have them
+         📄 index.html
+         📄 App.tsx
+         📄 main.tsx    <--------- Create and mount your app here
+         📄 style.css   <--------- Entrypoint-specific styles
+         📄 router.ts
+```
+
+## Configuring Routers
+
+All frameworks come with routers for building a multi-page app using the URL's path... But web extensions don't work like this. Since HTML files are static, `chrome-extension://{id}/popup.html`, there's no way to change the entire path for routing.
+
+Instead, you need to configure the router to run in "hash" mode, where the routing information is a part of the URL's hash, not the path (ie: `popup.html#/` and `popup.html#/account/settings`).
+
+Refer to your router's docs for information about hash mode and how to enable it. Here's a non-extensive list of a few popular routers:
+
+- [`react-router`](https://reactrouter.com/en/main/routers/create-hash-router)
+- [`vue-router`](https://router.vuejs.org/guide/essentials/history-mode.html#Hash-Mode)
+- [`svelte-spa-router`](https://www.npmjs.com/package/svelte-spa-router#hash-based-routing)
+- [`solid-router`](https://github.com/solidjs/solid-router?tab=readme-ov-file#hash-mode-router)

docs/guide/essentials/i18n.md

@@ -0,0 +1,90 @@
+# I18n
+
+[Chrome Docs](https://developer.chrome.com/docs/extensions/reference/api/i18n) • [Firefox Docs](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/i18n)
+
+This page discusses how to setup internationalization using the vanilla `browser.i18n` APIs and mentions some alternatives if you want to use something else.
+
+[[toc]]
+
+## Usage
+
+1. Add `default_locale` to your manifest:
+   ```ts
+   export default defineConfig({
+     manifest: {
+       default_locale: 'en',
+     },
+   });
+   ```
+2. Create `messages.json` files in the `public/` directory:
+
+   <!-- prettier-ignore -->
+   ```html
+   📂 {srcDir}/
+      📂 public/
+         📂 _locales/
+            📂 en/
+               📄 messages.json
+            📂 de/
+               📄 messages.json
+            📂 ko/
+               📄 messages.json
+   ```
+
+   ```jsonc
+   // public/_locales/en/messages.json
+   {
+     "helloWorld": {
+       "message": "Hello world!",
+     },
+   }
+   ```
+
+3. Get the translation:
+   ```ts
+   browser.i18n.getMessage('helloWorld');
+   ```
+4. _Optional_: Add translations for extension name and description:
+
+```json
+{
+  "extName": {
+    "message": "..."
+  },
+  "extDescription": {
+    "message": "..."
+  },
+  "helloWorld": {
+    "message": "Hello world!"
+  }
+}
+```
+
+```ts
+export default defineConfig({
+  manifest: {
+    name: '__MSG_extName__',
+    description: '__MSG_extDescription__',
+    default_locale: 'en',
+  },
+});
+```
+
+## Alternatives
+
+The vanilla API has very few features, which is why you may want to consider using third-party NPM packages like `i18next`, `react-i18n`, `vue-i18n`, etc.
+
+However, it is recommended you stick with the vanilla API (or a package based on top of the vanilla API, like [`@wxt-dev/i18n`](/i18n)), because:
+
+- They can localize text in your manifest and CSS files
+- Translations are loaded synchronously
+- Translations are not bundled multiple times, keeping your extension small
+- Zero configuration
+
+However, there is one major downside to the vanilla API and any packages built on top of it:
+
+- Language cannot be changed without changing your browser/system language
+
+Here are some examples of how to setup a third party i18n library:
+
+- [vue-i18n](https://github.com/wxt-dev/wxt-examples/tree/main/examples/vue-i18n)

docs/guide/essentials/messaging.md

@@ -0,0 +1,17 @@
+# Messaging
+
+[Chrome Docs](https://developer.chrome.com/docs/extensions/develop/concepts/messaging) • [Firefox Docs](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Content_scripts#communicating_with_background_scripts)
+
+Read the docs linked above to learn more about using the vanilla messaging APIs.
+
+## Alternatives
+
+The vanilla APIs are difficult to use and are a pain point to many new extension developers. For this reason, WXT recommends installing an NPM package that wraps around the vanilla APIs.
+
+Here are some popular messaging libraries that support all browsers and work with WXT:
+
+- [`trpc-chrome`](https://www.npmjs.com/package/trpc-chrome) - [tRPC](https://trpc.io/) adapter for Web Extensions.
+- [`webext-bridge`](https://www.npmjs.com/package/webext-bridge) - Messaging in WebExtensions made super easy. Out of the box.
+- [`@webext-core/messaging`](https://www.npmjs.com/package/@webext-core/messaging) - Light weight, type-safe wrapper around the web extension messaging APIs
+- [`@webext-core/proxy-service`](https://www.npmjs.com/package/@webext-core/proxy-service) - A type-safe wrapper around the web extension messaging APIs that lets you call a function from anywhere, but execute it in the background.
+- [`Comctx`](https://github.com/molvqingtai/comctx) - Cross-context RPC solution with type safety and flexible adapters.

docs/guide/essentials/project-structure.md

@@ -0,0 +1,99 @@
+# Project Structure
+
+WXT follows a strict project structure. By default, it's a flat folder structure that looks like this:
+
+<!-- prettier-ignore -->
+```html
+📂 {rootDir}/
+   📁 .output/
+   📁 .wxt/
+   📁 assets/
+   📁 components/
+   📁 composables/
+   📁 entrypoints/
+   📁 hooks/
+   📁 modules/
+   📁 public/
+   📁 utils/
+   📄 .env
+   📄 .env.publish
+   📄 app.config.ts
+   📄 package.json
+   📄 tsconfig.json
+   📄 web-ext.config.ts
+   📄 wxt.config.ts
+```
+
+Here's a brief summary of each of these files and directories:
+
+- `.output/`: All build artifacts will go here
+- `.wxt/`: Generated by WXT, it contains TS config
+- `assets/`: Contains all CSS, images, and other assets that should be processed by WXT
+- `components/`: Auto-imported by default, contains UI components
+- `composables/`: Auto-imported by default, contains composable functions for Vue
+- `entrypoints/`: Contains all the entrypoints that get bundled into your extension
+- `hooks/`: Auto-imported by default, contains hooks for React and Solid
+- `public/`: Contains any files you want to copy into the output folder as-is, without being processed by WXT
+- `utils/`: Auto-imported by default, contains generic utilities used throughout your project
+- `.env`: Contains [Environment Variables](/guide/essentials/config/environment-variables)
+- `.env.publish`: Contains Environment Variables for [publishing](/guide/essentials/publishing)
+- `app.config.ts`: Contains [Runtime Config](/guide/essentials/config/runtime)
+- `package.json`: The standard file used by your package manager
+- `tsconfig.json`: Config telling TypeScript how to behave
+- `web-ext.config.ts`: Configure [Browser Startup](/guide/essentials/config/browser-startup)
+- `wxt.config.ts`: The main config file for WXT projects
+
+## Adding a `src/` Directory
+
+Many developers like having a `src/` directory to separate source code from configuration files. You can enable it inside the `wxt.config.ts` file:
+
+```ts [wxt.config.ts]
+export default defineConfig({
+  srcDir: 'src',
+});
+```
+
+After enabling it, your project structure should look like this:
+
+<!-- prettier-ignore -->
+```html
+📂 {rootDir}/
+   📁 .output/
+   📁 .wxt/
+   📁 modules/
+   📁 public/
+   📂 src/
+      📁 assets/
+      📁 components/
+      📁 composables/
+      📁 entrypoints/
+      📁 hooks/
+      📁 utils/
+      📄 app.config.ts
+   📄 .env
+   📄 .env.publish
+   📄 package.json
+   📄 tsconfig.json
+   📄 web-ext.config.ts
+   📄 wxt.config.ts
+```
+
+## Customizing Other Directories
+
+You can configure the following directories:
+
+<!-- prettier-ignore -->
+```ts [wxt.config.ts]
+export default defineConfig({
+  // Relative to project root
+  srcDir: "src",             // default: "."
+  modulesDir: "wxt-modules", // default: "modules"
+  outDir: "dist",            // default: ".output"
+  publicDir: "static",       // default: "public"
+
+  // Relative to srcDir
+  entrypointsDir: "entries", // default: "entrypoints"
+})
+```
+
+You can use absolute or relative paths.

docs/guide/essentials/publishing.md

@@ -0,0 +1,228 @@
+---
+outline: deep
+---
+
+# Publishing
+
+WXT can ZIP your extension and submit it to various stores for review or for self-hosting.
+
+## First Time Publishing
+
+If you're publishing an extension to a store for the first time, you must manually navigate the process. WXT doesn't help you create listings, each store has unique steps and requirements that you need to familiarize yourself with.
+
+For specific details about each store, see the stores sections below.
+
+- [Chrome Web Store](#chrome-web-store)
+- [Firefox Addon Store](#firefox-addon-store)
+- [Edge Addons](#edge-addons)
+
+## Automation
+
+WXT provides two commands to help automate submitting a new version for review and publishing:
+
+- `wxt submit init`: Setup all the required secrets and options for the `wxt submit` command
+- `wxt submit`: Submit new versions of your extension for review (and publish them automatically once approved)
+
+To get started, run `wxt submit init` and follow the prompts. Once finished, you should have a `.env.submit` file! WXT will use this file to submit your updates.
+
+> In CI, make sure you add all the environment variables to the submit step.
+
+To submit a new version for publishing, build all the ZIPs you plan on releasing:
+
+```sh
+wxt zip
+wxt zip -b firefox
+```
+
+Then run the `wxt submit` command, passing in all the ZIP files you want to release. In this case, we'll do a release for all 3 major stores: Chrome Web Store, Edge Addons, and Firefox Addons Store.
+
+If it's your first time running the command or you recently made changes to the release process, you'll want to test your secrets by passing the `--dry-run` flag.
+
+```sh
+wxt submit --dry-run \
+  --chrome-zip .output/{your-extension}-{version}-chrome.zip \
+  --firefox-zip .output/{your-extension}-{version}-firefox.zip --firefox-sources-zip .output/{your-extension}-{version}-sources.zip \
+  --edge-zip .output/{your-extension}-{version}-chrome.zip
+```
+
+If the dry run passes, remove the flag and do the actual release:
+
+```sh
+wxt submit \
+  --chrome-zip .output/{your-extension}-{version}-chrome.zip \
+  --firefox-zip .output/{your-extension}-{version}-firefox.zip --firefox-sources-zip .output/{your-extension}-{version}-sources.zip \
+  --edge-zip .output/{your-extension}-{version}-chrome.zip
+```
+
+:::warning
+See the [Firefox Addon Store](#firefox-addon-store) section for more details about the `--firefox-sources-zip` option.
+:::
+
+## GitHub Action
+
+Here's an example of a GitHub Action that submits new versions of an extension for review. Ensure that you've added all required secrets used in the workflow to the repo's settings.
+
+```yml
+name: Release
+
+on:
+  workflow_dispatch:
+
+jobs:
+  submit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'pnpm'
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Zip extensions
+        run: |
+          pnpm zip
+          pnpm zip:firefox
+
+      - name: Submit to stores
+        run: |
+          pnpm wxt submit \
+            --chrome-zip .output/*-chrome.zip \
+            --firefox-zip .output/*-firefox.zip --firefox-sources-zip .output/*-sources.zip
+        env:
+          CHROME_EXTENSION_ID: ${{ secrets.CHROME_EXTENSION_ID }}
+          CHROME_CLIENT_ID: ${{ secrets.CHROME_CLIENT_ID }}
+          CHROME_CLIENT_SECRET: ${{ secrets.CHROME_CLIENT_SECRET }}
+          CHROME_REFRESH_TOKEN: ${{ secrets.CHROME_REFRESH_TOKEN }}
+          FIREFOX_EXTENSION_ID: ${{ secrets.FIREFOX_EXTENSION_ID }}
+          FIREFOX_JWT_ISSUER: ${{ secrets.FIREFOX_JWT_ISSUER }}
+          FIREFOX_JWT_SECRET: ${{ secrets.FIREFOX_JWT_SECRET }}
+```
+
+The action above lays the foundation for a basic workflow, including `zip` and `submit` steps. To further enhance your GitHub Action and delve into more complex scenarios, consider exploring the following examples from real projects. They introduce advanced features such as version management, changelog generation, and GitHub releases, tailored for different needs:
+
+- [`aklinker1/github-better-line-counts`](https://github.com/aklinker1/github-better-line-counts/blob/main/.github/workflows/submit.yml) - Conventional commits, automated version bump and changelog generation, triggered manually, optional dry run for testing
+- [`GuiEpi/plex-skipper`](https://github.com/GuiEpi/plex-skipper/blob/main/.github/workflows/deploy.yml) - Triggered automatically when `package.json` version is changed, creates and uploads artifacts to GitHub release.
+
+> These examples are designed to provide clear insights and are a good starting point for customizing your own workflows. Feel free to explore and adapt them to your project needs.
+
+## Stores
+
+### Chrome Web Store
+
+> ✅ Supported • [Developer Dashboard](https://chrome.google.com/webstore/developer/dashboard) • [Publishing Docs](https://developer.chrome.com/docs/webstore/publish/)
+
+To create a ZIP for Chrome:
+
+```sh
+wxt zip
+```
+
+### Firefox Addon Store
+
+> ✅ Supported • [Developer Dashboard](https://addons.mozilla.org/developers/) • [Publishing Docs](https://extensionworkshop.com/documentation/publish/submitting-an-add-on/)
+
+Firefox requires you to upload a ZIP of your source code. This allows them to rebuild your extension and review the code in a readable way. More details can be found in [Firefox's docs](https://extensionworkshop.com/documentation/publish/source-code-submission/).
+
+When running `wxt zip -b firefox`, WXT will zip both your extension and sources. Certain files (such as config files, hidden files, tests, and excluded entrypoints) are automatically excluded from your sources. However, it's important to manually check the ZIP to ensure it only contains the files necessary to rebuild your extension.
+
+To customize which files are zipped, add the `zip` option to your config file.
+
+```ts [wxt.config.ts]
+import { defineConfig } from 'wxt';
+
+export default defineConfig({
+  zip: {
+    // ...
+  },
+});
+```
+
+If it's your first time submitting to the Firefox Addon Store, or if you've updated your project layout, always test your sources ZIP! The commands below should allow you to rebuild your extension from inside the extracted ZIP.
+
+:::code-group
+
+```sh [pnpm]
+pnpm i
+pnpm zip:firefox
+```
+
+```sh [npm]
+npm i
+npm run zip:firefox
+```
+
+```sh [yarn]
+yarn
+yarn zip:firefox
+```
+
+```sh [bun]
+bun i
+bun zip:firefox
+```
+
+:::
+
+Ensure that you have a `README.md` or `SOURCE_CODE_REVIEW.md` file with the above commands so that the Firefox team knows how to build your extension.
+
+Make sure the build output is the exact same when running `wxt build -b firefox` in your main project and inside the zipped sources.
+
+:::warning
+If you use a `.env` files, they can affect the chunk hashes in the output directory. Either delete the .env file before running `wxt zip -b firefox`, or include it in your sources zip with the [`zip.includeSources`](/api/reference/wxt/interfaces/InlineConfig#includesources) option. Be careful to not include any secrets in your `.env` files.
+
+See Issue [#377](https://github.com/wxt-dev/wxt/issues/377) for more details.
+:::
+
+#### Private Packages
+
+If you use private packages and you don't want to provide your auth token to the Firefox team during the review process, you can use `zip.downloadPackages` to download any private packages and include them in the zip.
+
+```ts [wxt.config.ts]
+export default defineConfig({
+  zip: {
+    downloadPackages: [
+      '@mycompany/some-package',
+      //...
+    ],
+  },
+});
+```
+
+Depending on your package manager, the `package.json` in the sources zip will be modified to use the downloaded dependencies via the `overrides` or `resolutions` field.
+
+:::warning
+WXT uses the command `npm pack <package-name>` to download the package. That means regardless of your package manager, you need to properly setup a `.npmrc` file. NPM and PNPM both respect `.npmrc` files, but Yarn and Bun have their own ways of authorizing private registries, so you'll need to add a `.npmrc` file.
+:::
+
+### Safari
+
+> 🚧 Not supported yet
+
+WXT does not currently support automated publishing for Safari. Safari extensions require a native MacOS or iOS app wrapper, which WXT does not create yet. For now, if you want to publish to Safari, follow this guide:
+
+- [Converting a web extension for Safari](https://developer.apple.com/documentation/safariservices/safari_web_extensions/converting_a_web_extension_for_safari) - "Convert your existing extension to a Safari web extension using Xcode’s command-line tool."
+
+When running the `safari-web-extension-converter` CLI tool, pass the `.output/safari-mv2` or `.output/safari-mv3` directory, not your source code directory.
+
+```sh
+pnpm wxt build -b safari
+xcrun safari-web-extension-converter .output/safari-mv2
+```
+
+### Edge Addons
+
+> ✅ Supported &bull; [Developer Dashboard](https://aka.ms/PartnerCenterLogin) &bull; [Publishing Docs](https://learn.microsoft.com/en-us/microsoft-edge/extensions-chromium/publish/publish-extension)
+
+No need to create a specific ZIP for Edge. If you're already publishing to the Chrome Web Store, you can reuse your Chrome ZIP.
+
+However, if you have features specifically for Edge, create a separate ZIP with:
+
+```sh
+wxt zip -b edge
+```