Skip to content

Commit 8793f7b

Browse files
authored
chore: Manually fix markdownlint errors (#1711)
1 parent c1b3911 commit 8793f7b

File tree

13 files changed

+22
-20
lines changed

13 files changed

+22
-20
lines changed

.github/workflows/validate.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,7 @@ jobs:
2424
run: pnpm check
2525

2626
- name: Markdownlint
27-
run: pnpm experimental:check:md
28-
continue-on-error: true
27+
run: pnpm check:md
2928

3029
builds:
3130
name: Builds

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Published under the [MIT](https://github.com/wxt-dev/wxt/blob/main/LICENSE) lice
8989
Made by [@aklinker1](https://github.com/aklinker1) and [community](https://github.com/wxt-dev/wxt/graphs/contributors) 💛
9090
<br><br>
9191
<a href="https://github.com/wxt-dev/wxt/graphs/contributors">
92-
<img src="https://contrib.rocks/image?repo=wxt-dev/wxt" />
92+
<img src="https://contrib.rocks/image?repo=wxt-dev/wxt" alt="GitHub stars over time" />
9393
</a>
9494

9595
<!-- /automd -->

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
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:
66

7-
```
7+
```plaintext
88
.env
99
.env.local
1010
.env.[mode]

docs/guide/essentials/config/hooks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Because hooks can be defined in multiple places, including [WXT Modules](/guide/
3232

3333
To see the order for your project, run `wxt prepare --debug` flag and search for the "Hook execution order":
3434

35-
```
35+
```plaintext
3636
⚙ Hook execution order:
3737
⚙ 1. wxt:built-in:unimport
3838
⚙ 2. src/modules/auto-icons.ts

docs/guide/essentials/config/manifest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ If a version is not present in your `package.json`, it defaults to `"0.0.0"`.
128128

129129
WXT automatically discovers your extension's icon by looking at files in the `public/` directory:
130130

131-
```
131+
```plaintext
132132
public/
133133
├─ icon-16.png
134134
├─ icon-24.png

docs/guide/essentials/config/runtime.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ export default defineAppConfig({
2020
```
2121

2222
:::warning
23-
This file is committed to the repo, so don't put any secrets here. Instead, use [Environment Variables](#environment-variables)
23+
This file is committed to the repo, so don't put any secrets here. Instead, use [Environment Variables](/guide/essentials/config/environment-variables)
2424
:::
2525

2626
To access runtime config, WXT provides the `useAppConfig` function:

docs/guide/essentials/content-scripts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ export default defineContentScript({
1919

2020
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:
2121

22-
```
22+
```plaintext
2323
Error: Extension context invalidated.
2424
```
2525

docs/guide/essentials/wxt-modules.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ There are two ways to add a module to your project:
2020
2121
2. **Local**: add a file to your project's `modules/` directory:
2222

23-
```
23+
```plaintext
2424
<rootDir>/
2525
modules/
2626
my-module.ts

docs/guide/resources/faq.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -179,11 +179,11 @@ You don't need to crawl the entire website, these files already contain all the
179179

180180
To run the WXT dev server in a devcontainer, but load the dev build of your extension in your browser:
181181

182-
1. **Bind-mount your project directory to your host**
182+
1. **Bind-mount your project directory to your host**
183183
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.
184184

185-
2. **Disable auto-opening the browser**
186-
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`.
185+
2. **Disable auto-opening the browser**
186+
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`.
187187

188-
3. **Tell WXT to listen on all network interfaces**
188+
3. **Tell WXT to listen on all network interfaces**
189189
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`.

docs/guide/resources/upgrading.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -241,6 +241,7 @@ If you've previously loaded the extension into your browser manually for develop
241241
### Deprecated APIs Removed
242242
243243
- `entrypointLoader` option: WXT now uses `vite-node` for importing entrypoints during the build process.
244+
<!-- markdownlint-disable-next-line MD051 -->
244245
> This was deprecated in v0.19.0, see the [v0.19 section](#v0-18-5-rarr-v0-19-0) for migration steps.
245246
- `transformManifest` option: Use the `build:manifestGenerated` hook to transform the manifest instead:
246247
<!-- prettier-ignore -->
@@ -433,7 +434,7 @@ item.watch((newValue: number, oldValue: number) => { // [!code ++]
433434
434435
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.
435436
436-
```
437+
```plaintext
437438
.output/
438439
<target>/
439440
chunks/

0 commit comments

Comments
 (0)