Skip to content

Commit

Permalink
fix: update broken documentation links (#1635)
Browse files Browse the repository at this point in the history
  • Loading branch information
erikian committed Dec 18, 2023
1 parent dddd079 commit c588c69
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions README.md
Expand Up @@ -74,7 +74,7 @@ via [Homebrew](https://brew.sh/).

### Via JavaScript

JavaScript API usage can be found in the [API documentation](https://electron.github.io/packager/main/modules/electronpackager.html).
JavaScript API usage can be found in the [API documentation](https://electron.github.io/packager/main/).

### From the command line

Expand All @@ -101,7 +101,7 @@ This will:

For an overview of the other optional flags, run `electron-packager --help` or see
[usage.txt](https://github.com/electron/packager/blob/main/usage.txt). For
detailed descriptions, see the [API documentation](https://electron.github.io/packager/main/modules/electronpackager.html).
detailed descriptions, see the [API documentation](https://electron.github.io/packager/main/).

For flags that are structured as objects, you can pass each option as via dot notation as such:

Expand Down
4 changes: 2 additions & 2 deletions docs/faq.md
Expand Up @@ -14,7 +14,7 @@ and packaged modes, you'll need to [define it yourself](https://electronjs.org/d

## Why isn't my `ignore` option working?

As stated in the documentation for [`ignore`](https://electron.github.io/packager/main/interfaces/electronpackager.options.html#ignore), it uses "[one] or more additional
As stated in the documentation for [`ignore`](https://electron.github.io/packager/main/interfaces/Options.html#ignore), it uses "[one] or more additional
[regular expression](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions)
patterns. [] Please note that [glob patterns](https://en.wikipedia.org/wiki/Glob_%28programming%29)
will not work."
Expand Down Expand Up @@ -44,7 +44,7 @@ console.log(require(jsonFilename));

## How do I set an icon on Linux?

The docs for [`icon`](https://electron.github.io/packager/main/interfaces/electronpackager.options.html#icon)
The docs for [`icon`](https://electron.github.io/packager/main/interfaces/Options.html#icon)
already show how to set an icon on your `BrowserWindow`, but your dock/taskbar may not use that and
instead use the `Icon` value in your `.desktop` file. The [Linux distributable creators](https://github.com/electron/packager#distributable-creators)
can help you set/distribute the appropriate icon in that case.
2 changes: 1 addition & 1 deletion src/infer.ts
Expand Up @@ -32,7 +32,7 @@ function errorMessageForProperty(prop: string) {

return `Unable to determine ${propDescription}. Please specify an ${propDescription}\n\n` +
'For more information, please see\n' +
`https://electron.github.io/packager/main/interfaces/electronpackager.options.html#${hash}\n`;
`https://electron.github.io/packager/main/interfaces/Options.html#${hash}\n`;
}

function resolvePromise(id: string, options: AsyncOpts) {
Expand Down
4 changes: 2 additions & 2 deletions usage.txt
Expand Up @@ -55,7 +55,7 @@ extra-resource a file to copy into the app's resources directory
icon the local path to an icon file to use as the icon for the app.
Note: Format depends on platform.
ignore do not copy files into app whose filenames RegExp.match this string. See also:
https://electron.github.io/packager/main/interfaces/electronpackager.options.html#ignore
https://electron.github.io/packager/main/interfaces/Options.html#ignore
and --no-prune. Can be specified multiple times
no-deref-symlinks make sure symlinks are not dereferenced within the app source
no-junk do not ignore system junk files from the packaged app
Expand Down Expand Up @@ -102,7 +102,7 @@ osx-universal (macOS host platform only, requires --arch=universal) Options
when packaging a Universal macOS binary. You must use dot notation to configure a list of sub-properties,
e.g. --osx-universal.mergeASARs="true"
For info on supported values see
https://electron.github.io/packager/main/modules/electronpackager.html#osxuniversaloptions
https://electron.github.io/packager/main/types/OsxUniversalOptions.html
windows-sign Whether to sign Windows binary files with a codesigning certificate. You can either
pass --windows-sign by itself to use the default configuration or use dot notation to configure
a list of sub-properties, e.g. --windows-sign.certificateFile="C:\cert.pfx".
Expand Down

0 comments on commit c588c69

Please sign in to comment.