diff --git a/.github/workflows/validate.yml b/.github/workflows/validate.yml index 7a9f8271..02e88476 100644 --- a/.github/workflows/validate.yml +++ b/.github/workflows/validate.yml @@ -24,8 +24,7 @@ jobs: run: pnpm check - name: Markdownlint - run: pnpm experimental:check:md - continue-on-error: true + run: pnpm check:md builds: name: Builds diff --git a/README.md b/README.md index 8dfd7404..55a77958 100644 --- a/README.md +++ b/README.md @@ -89,7 +89,7 @@ Published under the [MIT](https://github.com/wxt-dev/wxt/blob/main/LICENSE) lice Made by [@aklinker1](https://github.com/aklinker1) and [community](https://github.com/wxt-dev/wxt/graphs/contributors) 💛

- +GitHub stars over time diff --git a/docs/guide/essentials/config/environment-variables.md b/docs/guide/essentials/config/environment-variables.md index 35453433..f1ba8960 100644 --- a/docs/guide/essentials/config/environment-variables.md +++ b/docs/guide/essentials/config/environment-variables.md @@ -4,7 +4,7 @@ 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: -``` +```plaintext .env .env.local .env.[mode] diff --git a/docs/guide/essentials/config/hooks.md b/docs/guide/essentials/config/hooks.md index e735ff4a..3c193f8e 100644 --- a/docs/guide/essentials/config/hooks.md +++ b/docs/guide/essentials/config/hooks.md @@ -32,7 +32,7 @@ Because hooks can be defined in multiple places, including [WXT Modules](/guide/ To see the order for your project, run `wxt prepare --debug` flag and search for the "Hook execution order": -``` +```plaintext ⚙ Hook execution order: ⚙ 1. wxt:built-in:unimport ⚙ 2. src/modules/auto-icons.ts diff --git a/docs/guide/essentials/config/manifest.md b/docs/guide/essentials/config/manifest.md index 2a1ab0ae..6af5f93e 100644 --- a/docs/guide/essentials/config/manifest.md +++ b/docs/guide/essentials/config/manifest.md @@ -128,7 +128,7 @@ If a version is not present in your `package.json`, it defaults to `"0.0.0"`. WXT automatically discovers your extension's icon by looking at files in the `public/` directory: -``` +```plaintext public/ ├─ icon-16.png ├─ icon-24.png diff --git a/docs/guide/essentials/config/runtime.md b/docs/guide/essentials/config/runtime.md index 47f3c6fd..d61e4c51 100644 --- a/docs/guide/essentials/config/runtime.md +++ b/docs/guide/essentials/config/runtime.md @@ -20,7 +20,7 @@ export default defineAppConfig({ ``` :::warning -This file is committed to the repo, so don't put any secrets here. Instead, use [Environment Variables](#environment-variables) +This file is committed to the repo, so don't put any secrets here. Instead, use [Environment Variables](/guide/essentials/config/environment-variables) ::: To access runtime config, WXT provides the `useAppConfig` function: diff --git a/docs/guide/essentials/content-scripts.md b/docs/guide/essentials/content-scripts.md index 42244e99..b9777af3 100644 --- a/docs/guide/essentials/content-scripts.md +++ b/docs/guide/essentials/content-scripts.md @@ -19,7 +19,7 @@ export default defineContentScript({ 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: -``` +```plaintext Error: Extension context invalidated. ``` diff --git a/docs/guide/essentials/wxt-modules.md b/docs/guide/essentials/wxt-modules.md index cb475074..ac085b91 100644 --- a/docs/guide/essentials/wxt-modules.md +++ b/docs/guide/essentials/wxt-modules.md @@ -20,7 +20,7 @@ There are two ways to add a module to your project: 2. **Local**: add a file to your project's `modules/` directory: - ``` + ```plaintext / modules/ my-module.ts diff --git a/docs/guide/resources/faq.md b/docs/guide/resources/faq.md index 6d11f8f1..7d9b8cbc 100644 --- a/docs/guide/resources/faq.md +++ b/docs/guide/resources/faq.md @@ -179,11 +179,11 @@ You don't need to crawl the entire website, these files already contain all the To run the WXT dev server in a devcontainer, but load the dev build of your extension in your browser: -1. **Bind-mount your project directory to your host** +1. **Bind-mount your project directory to your host** If you're using VS Code, you can open your project folder with the `Dev Containers: Open Folder in Container...` command. This keeps the folder synchronized between your host and the devcontainer, ensuring that the extension `dist` directory remains accessible from the host. -2. **Disable auto-opening the browser** - WXT automatically opens your browser during development, but since you're running inside a container, it won't be able to access it. Follow the instructions [here](https://wxt.dev/guide/essentials/config/browser-startup.html#disable-opening-browser) to disable browser auto-opening in your `wxt.config.ts`. +2. **Disable auto-opening the browser** + WXT automatically opens your browser during development, but since you're running inside a container, it won't be able to access it. Follow [the guide here](https://wxt.dev/guide/essentials/config/browser-startup.html#disable-opening-browser) to disable browser auto-opening in your `wxt.config.ts`. -3. **Tell WXT to listen on all network interfaces** +3. **Tell WXT to listen on all network interfaces** To enable hot-reloading, your extension has to connect to the WXT dev server running inside your container. WXT will only listen on `localhost` by default, which prevents connections from outside the devcontainer. To fix this you can instruct WXT to listen on all interfaces with `wxt --host 0.0.0.0`. diff --git a/docs/guide/resources/upgrading.md b/docs/guide/resources/upgrading.md index ef963bdd..09cb0aa5 100644 --- a/docs/guide/resources/upgrading.md +++ b/docs/guide/resources/upgrading.md @@ -241,6 +241,7 @@ If you've previously loaded the extension into your browser manually for develop ### Deprecated APIs Removed - `entrypointLoader` option: WXT now uses `vite-node` for importing entrypoints during the build process. + > This was deprecated in v0.19.0, see the [v0.19 section](#v0-18-5-rarr-v0-19-0) for migration steps. - `transformManifest` option: Use the `build:manifestGenerated` hook to transform the manifest instead: @@ -433,7 +434,7 @@ item.watch((newValue: number, oldValue: number) => { // [!code ++] JS entrypoints in the output directory have been moved. Unless you're doing some kind of post-build work referencing files, you don't have to make any changes. -``` +```plaintext .output/ / chunks/ diff --git a/package.json b/package.json index fd44fad1..3cc58e40 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,7 @@ "packageManager": "pnpm@10.10.0", "scripts": { "check": "check && pnpm -r --sequential run check", - "experimental:check:md": "markdownlint .", + "check:md": "markdownlint .", "test": "pnpm -r --sequential run test run", "test:coverage": "pnpm -r --sequential run test:coverage", "prepare": "simple-git-hooks", diff --git a/packages/i18n/README.md b/packages/i18n/README.md index b5c35742..87229960 100644 --- a/packages/i18n/README.md +++ b/packages/i18n/README.md @@ -6,7 +6,7 @@ 1. Simple messages file format 2. Plural form support -3. Integrates with the [I18n Ally VS Code extension](#vscode) +3. Integrates with the [I18n Ally VS Code extension](#vs-code) It also provides several benefits over other non-web extension specific i18n packages: @@ -81,7 +81,7 @@ And you're done! Using WXT, you get type-safety out of the box. > [!NOTE] > For the best DX, you should to integrate `@wxt-dev/i18n` into your build process. This enables: - + > > 1. Plural forms > 2. Simple messages file format > 3. Type safety diff --git a/packages/runner/README.md b/packages/runner/README.md index a38f30c1..6a92be31 100644 --- a/packages/runner/README.md +++ b/packages/runner/README.md @@ -2,7 +2,9 @@ Programmatically open a browser and install a web extension from a local directory. -###### With WXT +## Usage + +### With WXT > [!WARNING] > This package is intended to replace [`web-ext`](https://github.com/mozilla/web-ext) in the future, but it is not ready at the moment. Once it's ready for testing in WXT, more details will be added here. @@ -16,7 +18,7 @@ export default defineRunnerConfig({ }); ``` -###### JS API +### JS API ```ts import { run } from '@wxt-dev/runner'; @@ -153,7 +155,7 @@ To see debug logs, set the `DEBUG` env var to `"@wxt-dev/runner"`. This will pri
Example debug output -``` +```plaintext @wxt-dev/runner:options User options: { extensionDir: 'demo-extension', target: undefined } @wxt-dev/runner:options Resolved options: { browserBinary: '/usr/bin/chromium',