Skip to content

Commit af4105f

Browse files
committed
Update several links and pages
1 parent 6ef4e25 commit af4105f

19 files changed

+196
-183
lines changed

docs/en/docs/browsers/_meta.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
[
22
{
3-
"name": "available",
3+
"name": "browsers-available",
44
"label": "Browsers Available"
55
},
66
{
7-
"name": "preferences",
7+
"name": "browser-preferences",
88
"label": "Browser Preferences"
99
},
1010
{
11-
"name": "flags",
11+
"name": "browser-flags",
1212
"label": "Browser Flags"
1313
},
1414
{
15-
"name": "profile",
15+
"name": "browser-profile",
1616
"label": "Browser Profile"
1717
},
1818
{
19-
"name": "unsupported",
20-
"label": "Running Browsers From Binary"
19+
"name": "running-other-browsers",
20+
"label": "Running Other Browsers"
2121
}
2222
]

docs/en/docs/browsers/flags.mdx renamed to docs/en/docs/browsers/browser-flags.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,5 +60,5 @@ If your target browser is not listed here, it may not have publicly disclosed it
6060

6161
## Next Steps
6262

63-
- Learn more about [Browser Preferences](./preferences.mdx).
63+
- Learn more about [Browser Preferences](./browser-preferences.mdx).
6464
- Explore [Browser-Specific Environment Files](../features/environment-variables.mdx).

docs/en/docs/browsers/preferences.mdx renamed to docs/en/docs/browsers/browser-preferences.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,4 +87,4 @@ For a comprehensive list of available Firefox preferences, you can explore the [
8787
## Next Steps
8888

8989
- Learn more about [browser-specific environment files](../features/environment-variables.mdx).
90-
- Explore how to [configure other browser preferences](./available.mdx).
90+
- Explore how to [configure other browser preferences](./browsers-available.mdx).
File renamed without changes.

docs/en/docs/browsers/available.mdx renamed to docs/en/docs/browsers/browsers-available.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,5 +34,5 @@ Any browser based on the Chromium engine (e.g., Brave or Opera) is supported wit
3434

3535
## Next Steps
3636

37-
- [Customize your browser configuration](./flags.mdx) using the `--browser-args` flag.
38-
- [Learn more about unsupported browsers](./unsupported.mdx) and how to run your extension on them.
37+
- [Customize your browser configuration](./browser-flags.mdx) using the `--browser-args` flag.
38+
- [Learn more about unsupported browsers](./running-other-browsers.mdx) and how to run your extension on them.

docs/en/docs/browsers/unsupported.mdx renamed to docs/en/docs/browsers/running-other-browsers.mdx

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@ import { AvatarBrowsers } from "../../../../theme/components/avatar-group/browse
22

33
<AvatarBrowsers browsers={["waterfox", "opera", "brave"]} />
44

5-
# Running Browsers From Binary
5+
# Running Other Browsers From Binary Path
66

77
> **Warning**: This feature is a work in progress and may be incomplete or subject to change. If you see an error or something that could be improved, please make a pull request. The link that documents this feature can be found at the bottom of the page.
88
9-
While Extension.js natively supports browsers like Chrome, Edge, and Firefox, you can also run unsupported browsers by specifying the path to the browser binary using the `--chromiumBinary` or `--geckoBinary` flags. Additionally, you can add custom binary paths via the `extension.config.js` file for persistent configuration across runs.
9+
While Extension.js natively supports browsers like Chrome, Edge, and Firefox, you can also run unsupported browsers by specifying the path to the browser binary using the `--chromium-binary` or `--gecko-binary` flags. Additionally, you can add custom binary paths via the `extension.config.js` file for persistent configuration across runs.
1010

1111
## How Does It Work?
1212

13-
If you need to run a browser that is not fully supported by Extension.js, you can specify the path to a custom browser binary using the `--chromiumBinary` or `--geckoBinary` flags. Extension.js will launch the specified browser binary with your extension loaded, allowing you to test your extension in a custom browser environment.
13+
If you need to run a browser that is not fully supported by Extension.js, you can specify the path to a custom browser binary using the `--chromium-binary` or `--gecko-binary` flags. Extension.js will launch the specified browser binary with your extension loaded, allowing you to test your extension in a custom browser environment.
1414

1515
**Example Using CLI Flags:**
1616

@@ -45,20 +45,20 @@ In these scenarios, the browser specified in the `--chromiumBinary` or `--geckoB
4545

4646
Here is a short list of browsers you can run using these binary flags, along with their official websites for reference:
4747

48-
| **Browser Name** | **Type** | **CLI Flag** | **Official Website** |
49-
| ----------------------------- | ---------------------- | ------------------ | --------------------------------------------------------- |
50-
| **Brave** | Chromium-Based Browser | `--chromiumBinary` | [brave.com](https://brave.com) |
51-
| **Opera** | Chromium-Based Browser | `--chromiumBinary` | [opera.com](https://www.opera.com) |
52-
| **Vivaldi** | Chromium-Based Browser | `--chromiumBinary` | [vivaldi.com](https://vivaldi.com) |
53-
| **Waterfox** | Gecko-Based Browser | `--geckoBinary` | [waterfox.net](https://www.waterfox.net) |
54-
| **Firefox Developer Edition** | Gecko-Based Browser | `--geckoBinary` | [firefox.com](https://www.mozilla.org/firefox/developer/) |
48+
| **Browser Name** | **Type** | **CLI Flag** | **Official Website** |
49+
| ----------------------------- | ---------------------- | ------------------- | --------------------------------------------------------- |
50+
| **Brave** | Chromium-Based Browser | `--chromium-binary` | [brave.com](https://brave.com) |
51+
| **Opera** | Chromium-Based Browser | `--chromium-binary` | [opera.com](https://www.opera.com) |
52+
| **Vivaldi** | Chromium-Based Browser | `--chromium-binary` | [vivaldi.com](https://vivaldi.com) |
53+
| **Waterfox** | Gecko-Based Browser | `--gecko-binary` | [waterfox.net](https://www.waterfox.net) |
54+
| **Firefox Developer Edition** | Gecko-Based Browser | `--gecko-binary` | [firefox.com](https://www.mozilla.org/firefox/developer/) |
5555

5656
## Example Configuration
5757

58-
Below is an example configuration using the `--geckoBinary` flag to run a custom Firefox instance with specific preferences and flags:
58+
Below is an example configuration using the `--gecko-binary` flag to run a custom Firefox instance with specific preferences and flags:
5959

6060
```bash
61-
extension dev --geckoBinary=/path/to/custom-firefox --profile=/path/to/firefox/profile
61+
extension dev --gecko-binary=/path/to/custom-firefox --profile=/path/to/firefox/profile
6262
```
6363

6464
Or via `extension.config.js`:
@@ -87,4 +87,4 @@ module.exports = {
8787

8888
## Next Steps
8989

90-
- Check out the [browser preferences](./preferences.mdx) to further configure your environment.
90+
- Check out the [browser preferences](./browser-preferences.mdx) to further configure your environment.

docs/en/docs/commands/build.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,4 +117,4 @@ In this example, the build targets all supported browsers and includes polyfills
117117
## Next Steps
118118

119119
- Use the `extension.config.js` file to [configure your extension](https://github.com/extension-js/extension.js/tree/main/examples).
120-
- Learn more about the [browsers available](../browsers/available.mdx).
120+
- Learn more about the [browsers available](../browsers/browsers-available.mdx).

docs/en/docs/commands/create.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,4 +99,4 @@ This command creates a new extension named my-new-extension using the React temp
9999
## Next Steps
100100

101101
- Learn how to [develop](/docs/commands/dev) your extension.
102-
- Use the `extension.config.js` file to [configure your extension](../features/config.mdx).
102+
- Use the `extension.config.js` file to [configure your extension](../features/extension-configuration.mdx).

docs/en/docs/commands/dev.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ Below is a breakdown of the available flags for the `dev` command:
5252
| `--polyfill` | Boolean | Enables compatibility for the `browser.*` API in Chromium-based browsers | `false` |
5353
| `--profile` | Profile path | Specifies a path to a browser profile for testing | `default` |
5454
| `-b, --browser` | Browser to run the extension | Specifies the browser to run (`chrome`, `edge`, `firefox`, `all`) | `"chrome"` |
55-
| `--chromium-binary` | Path to the Chromium binary | Provides the path to a custom Chromium-based browser binary [Read more](../browsers/unsupported.mdx) | `undefined` |
56-
| `--gecko-binary` | Path to the Gecko binary | Provides the path to a custom Gecko-based browser binary [Read more](../browsers/unsupported.mdx) | `undefined` |
55+
| `--chromium-binary` | Path to the Chromium binary | Provides the path to a custom Chromium-based browser binary [Read more](../browsers/running-other-browsers.mdx) | `undefined` |
56+
| `--gecko-binary` | Path to the Gecko binary | Provides the path to a custom Gecko-based browser binary [Read more](../browsers/running-other-browsers.mdx) | `undefined` |
5757
| `--starting-url` | URL | Starting URL for testing with the extension | `chrome://newtab` |
5858
| `--open` | Boolean | Whether or not to automatically open the browser upon starting dev | `true` |
5959

@@ -127,5 +127,5 @@ Below is a breakdown of the available flags for the `dev` command:
127127
## Next Steps
128128

129129
- Once development is complete, it's time to [build your extension](/docs/commands/build).
130-
- Learn how to create features specific to a browser with the [browser-specific manifest fields](/docs/features/browser-fields).
131-
- Use the `extension.config.js` file to [configure your extension](/docs/features/config).
130+
- Learn how to create features specific to a browser with the [browser-specific manifest fields](/docs/features/browser-specific-fields).
131+
- Use the `extension.config.js` file to [configure your extension](/docs/features/extension-configuration).

docs/en/docs/commands/preview.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ In this example, the extension is created in the `path/to/my-extension` director
4545
| [path or url] | The extension path or the remote extension URL | If a path is defined, previews the local extension. If a URL is provided, pulls the extension from remote source and previews it as a local extension | `process.cwd()` |
4646
| `--profile` | Profile path | Specifies a path to a browser profile for testing | `default` |
4747
| `-b, --browser` | Browser to run the extension | Specifies the browser to run (`chrome`, `edge`, `firefox`, `all`) | `"chrome"` |
48-
| `--chromium-binary` | Path to the Chromium binary | Provides the path to a custom Chromium-based browser binary [Read more](../browsers/unsupported.mdx) | `undefined` |
49-
| `--gecko-binary` | Path to the Gecko binary | Provides the path to a custom Gecko-based browser binary [Read more](../browsers/unsupported.mdx) | `undefined` |
48+
| `--chromium-binary` | Path to the Chromium binary | Provides the path to a custom Chromium-based browser binary [Read more](../browsers/running-other-browsers.mdx) | `undefined` |
49+
| `--gecko-binary` | Path to the Gecko binary | Provides the path to a custom Gecko-based browser binary [Read more](../browsers/running-other-browsers.mdx) | `undefined` |
5050
| `--starting-url` | URL | Starting URL for testing with the extension | `chrome://newtab` |
5151

5252
## Examples
@@ -95,4 +95,4 @@ In this example, the extension is created in the `path/to/my-extension` director
9595
## Next Steps
9696

9797
- Learn how to [build](/docs/commands/build) your extension.
98-
- Use the `extension.config.js` file to [configure your extension](/docs/features/config).
98+
- Use the `extension.config.js` file to [configure your extension](/docs/features/extension-configuration).

0 commit comments

Comments
 (0)