chore: Manually fix markdownlint errors (#1711)

This commit is contained in:
Aaron
2025-06-04 18:30:54 -05:00
committed by GitHub
parent c1b3911622
commit 8793f7bff4
13 changed files with 22 additions and 20 deletions
+1 -2
View File
@@ -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
+1 -1
View File
@@ -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) 💛
<br><br>
<a href="https://github.com/wxt-dev/wxt/graphs/contributors">
<img src="https://contrib.rocks/image?repo=wxt-dev/wxt" />
<img src="https://contrib.rocks/image?repo=wxt-dev/wxt" alt="GitHub stars over time" />
</a>
<!-- /automd -->
@@ -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]
+1 -1
View File
@@ -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
+1 -1
View File
@@ -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
+1 -1
View File
@@ -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:
+1 -1
View File
@@ -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.
```
+1 -1
View File
@@ -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
<rootDir>/
modules/
my-module.ts
+4 -4
View File
@@ -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`.
+2 -1
View File
@@ -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.
<!-- markdownlint-disable-next-line MD051 -->
> 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:
<!-- prettier-ignore -->
@@ -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/
<target>/
chunks/
+1 -1
View File
@@ -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",
+2 -2
View File
@@ -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
+5 -3
View File
@@ -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
<details>
<summary>Example debug output</summary>
```
```plaintext
@wxt-dev/runner:options User options: { extensionDir: 'demo-extension', target: undefined }
@wxt-dev/runner:options Resolved options: {
browserBinary: '/usr/bin/chromium',