Update Docs (#2944)

Co-authored-by: tauri-bot <[email protected]>
tauri-apps · Nov 5, 2024 · 5c07d25 · 5c07d25
1 parent 3689ffd
commit 5c07d25
Show file tree

Hide file tree

Showing 15 changed files with 225 additions and 222 deletions.
diff --git a/docs/api/config.md b/docs/api/config.md
@@ -29,7 +29,9 @@ The configuration is composed of the following objects:
 - [`build`](#buildconfig): The build configuration
 - [`plugins`](#pluginconfig): The plugins config
 
-```json title="Example tauri.config.json file" 
+Example tauri.config.json file:
+
+```json 
 {
   "build": {
     "beforeBuildCommand": "",
@@ -204,7 +206,7 @@ Can be any **ONE** of the following types:
 - "Overlay": Shows the title bar as a transparent overlay over the window's content.
 
 	Keep in mind:
-- The height of the title bar is different on different OS versions, which can lead to window the controls and title not being where you don't expect.
+- The height of the title bar is different on different OS versions, which can lead to the window controls and title not being where you expect them to be.
 - You need to define a custom drag region to make your window draggable, however due to a limitation you can't drag the window when it's not in focus <https://github.com/tauri-apps/tauri/issues/4316>.
 - The color of the window title depends on the system theme.
 
@@ -267,7 +269,7 @@ Type: `object`
 | ---- | ---- | ------- | ----------- |
 | <div className="anchor-with-padding" id="bundleconfig.active">`active`<a class="hash-link" href="#bundleconfig.active"></a></div> | boolean | `false` | Whether Tauri should bundle your application or just output the executable. |
 | <div className="anchor-with-padding" id="bundleconfig.targets">`targets`<a class="hash-link" href="#bundleconfig.targets"></a></div> | [`BundleTarget`](#bundletarget) | [view](#bundletarget) | The bundle targets, currently supports ["deb", "rpm", "appimage", "nsis", "msi", "app", "dmg", "updater"] or "all". |
-| <div className="anchor-with-padding" id="bundleconfig.identifier">`identifier`<a class="hash-link" href="#bundleconfig.identifier"></a></div> | string (required) |  | The application identifier in reverse domain name notation (e.g. `com.tauri.example`). This string must be unique across applications since it is used in system configurations like the bundle ID and path to the webview data directory. This string must contain only alphanumeric characters (A–Z, a–z, and 0–9), hyphens (-), and periods (.). |
+| <div className="anchor-with-padding" id="bundleconfig.identifier">`identifier`<a class="hash-link" href="#bundleconfig.identifier"></a></div> | string (required) |  | The application identifier in reverse domain name notation (e.g. `com.tauri.example`). This string must be unique across applications since it is used in system configurations like the bundle ID and path to the webview data directory. This string must contain only alphanumeric characters (A-Z, a-z, and 0-9), hyphens (-), and periods (.). |
 | <div className="anchor-with-padding" id="bundleconfig.publisher">`publisher`<a class="hash-link" href="#bundleconfig.publisher"></a></div> | string? | _null_ | The application's publisher. Defaults to the second element in the identifier string. Currently maps to the Manufacturer property of the Windows Installer. |
 | <div className="anchor-with-padding" id="bundleconfig.icon">`icon`<a class="hash-link" href="#bundleconfig.icon"></a></div> | string[] | [] | The app's icons |
 | <div className="anchor-with-padding" id="bundleconfig.resources">`resources`<a class="hash-link" href="#bundleconfig.resources"></a></div> | [`BundleResources`](#bundleresources)? | [view](#bundleresources) | App resources to bundle. Each resource is a path to a file or directory. Glob patterns are supported. |
@@ -361,7 +363,7 @@ Type: `object`
 | <div className="anchor-with-padding" id="rpmconfig.depends">`depends`<a class="hash-link" href="#rpmconfig.depends"></a></div> | array? | _null_ | The list of RPM dependencies your application relies on. |
 | <div className="anchor-with-padding" id="rpmconfig.provides">`provides`<a class="hash-link" href="#rpmconfig.provides"></a></div> | array? | _null_ | The list of RPM dependencies your application provides. |
 | <div className="anchor-with-padding" id="rpmconfig.conflicts">`conflicts`<a class="hash-link" href="#rpmconfig.conflicts"></a></div> | array? | _null_ | The list of RPM dependencies your application conflicts with. They must not be present in order for the package to be installed. |
-| <div className="anchor-with-padding" id="rpmconfig.obsoletes">`obsoletes`<a class="hash-link" href="#rpmconfig.obsoletes"></a></div> | array? | _null_ | The list of RPM dependencies your application supersedes<br />- if this package is installed, packages listed as “obsoletes” will be automatically removed (if they are present). |
+| <div className="anchor-with-padding" id="rpmconfig.obsoletes">`obsoletes`<a class="hash-link" href="#rpmconfig.obsoletes"></a></div> | array? | _null_ | The list of RPM dependencies your application supersedes<br />- if this package is installed, packages listed as "obsoletes" will be automatically removed (if they are present). |
 | <div className="anchor-with-padding" id="rpmconfig.release">`release`<a class="hash-link" href="#rpmconfig.release"></a></div> | string | _null_ | The RPM release tag. |
 | <div className="anchor-with-padding" id="rpmconfig.epoch">`epoch`<a class="hash-link" href="#rpmconfig.epoch"></a></div> | integer _(format: `uint32`)_ | `0` | The RPM epoch. |
 | <div className="anchor-with-padding" id="rpmconfig.files">`files`<a class="hash-link" href="#rpmconfig.files"></a></div> | object | _null_ | The files to include on the package. |
@@ -420,6 +422,7 @@ Type: `object`
 | <div className="anchor-with-padding" id="macconfig.exceptiondomain">`exceptionDomain`<a class="hash-link" href="#macconfig.exceptiondomain"></a></div> | string? | _null_ | Allows your application to communicate with the outside world. It should be a lowercase, without port and protocol domain name. |
 | <div className="anchor-with-padding" id="macconfig.license">`license`<a class="hash-link" href="#macconfig.license"></a></div> | string? | _null_ | The path to the license file to add to the DMG bundle. |
 | <div className="anchor-with-padding" id="macconfig.signingidentity">`signingIdentity`<a class="hash-link" href="#macconfig.signingidentity"></a></div> | string? | _null_ | Identity to use for code signing. |
+| <div className="anchor-with-padding" id="macconfig.hardenedruntime">`hardenedRuntime`<a class="hash-link" href="#macconfig.hardenedruntime"></a></div> | boolean | `true` | Whether the codesign should enable [hardened runtime](https://developer.apple.com/documentation/security/hardened_runtime) (for executables) or not. |
 | <div className="anchor-with-padding" id="macconfig.providershortname">`providerShortName`<a class="hash-link" href="#macconfig.providershortname"></a></div> | string? | _null_ | Provider short name for notarization. |
 | <div className="anchor-with-padding" id="macconfig.entitlements">`entitlements`<a class="hash-link" href="#macconfig.entitlements"></a></div> | string? | _null_ | Path to the entitlements file. |
 

diff --git a/docs/api/js/cli.md b/docs/api/js/cli.md
@@ -18,7 +18,7 @@ This package is also accessible with `window.__TAURI__.cli` when [`build.withGlo
 
 Number of occurrences
 
-**Defined in:** [cli.ts:27](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/cli.ts#L27)
+**Defined in:** [cli.ts:27](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/cli.ts#L27)
 
 ##### `value`
 
@@ -28,7 +28,7 @@ string if takes value
 boolean if flag
 string[] or null if takes multiple values
 
-**Defined in:** [cli.ts:23](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/cli.ts#L23)
+**Defined in:** [cli.ts:23](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/cli.ts#L23)
 
 ### `CliMatches`
 
@@ -40,13 +40,13 @@ string[] or null if takes multiple values
 
 >  **args**: [`Record`]( https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type )<`string`, [`ArgMatch`](cli.md#argmatch)\>
 
-**Defined in:** [cli.ts:42](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/cli.ts#L42)
+**Defined in:** [cli.ts:42](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/cli.ts#L42)
 
 ##### `subcommand`
 
 >  **subcommand**: `null` \| [`SubcommandMatch`](cli.md#subcommandmatch)
 
-**Defined in:** [cli.ts:43](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/cli.ts#L43)
+**Defined in:** [cli.ts:43](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/cli.ts#L43)
 
 ### `SubcommandMatch`
 
@@ -58,13 +58,13 @@ string[] or null if takes multiple values
 
 >  **matches**: [`CliMatches`](cli.md#climatches)
 
-**Defined in:** [cli.ts:35](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/cli.ts#L35)
+**Defined in:** [cli.ts:35](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/cli.ts#L35)
 
 ##### `name`
 
 >  **name**: `string`
 
-**Defined in:** [cli.ts:34](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/cli.ts#L34)
+**Defined in:** [cli.ts:34](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/cli.ts#L34)
 
 ## Functions
 

diff --git a/docs/api/js/dialog.md b/docs/api/js/dialog.md
@@ -35,31 +35,31 @@ It is recommended to allowlist only the APIs you use for optimal bundle size and
 
 The label of the cancel button.
 
-**Defined in:** [dialog.ts:112](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/dialog.ts#L112)
+**Defined in:** [dialog.ts:112](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L112)
 
 ##### `okLabel`
 
 > `Optional` **okLabel**: `string`
 
 The label of the confirm button.
 
-**Defined in:** [dialog.ts:110](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/dialog.ts#L110)
+**Defined in:** [dialog.ts:110](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L110)
 
 ##### `title`
 
 > `Optional` **title**: `string`
 
 The title of the dialog. Defaults to the app name.
 
-**Defined in:** [dialog.ts:106](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/dialog.ts#L106)
+**Defined in:** [dialog.ts:106](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L106)
 
 ##### `type`
 
 > `Optional` **type**: `"info"` \| `"warning"` \| `"error"`
 
 The type of the dialog. Defaults to `info`.
 
-**Defined in:** [dialog.ts:108](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/dialog.ts#L108)
+**Defined in:** [dialog.ts:108](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L108)
 
 ### `DialogFilter`
 
@@ -81,15 +81,15 @@ Extensions to filter, without a `.` prefix.
 extensions: ['svg', 'png']
 ```
 
-**Defined in:** [dialog.ts:48](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/dialog.ts#L48)
+**Defined in:** [dialog.ts:48](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L48)
 
 ##### `name`
 
 >  **name**: `string`
 
 Filter name.
 
-**Defined in:** [dialog.ts:40](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/dialog.ts#L40)
+**Defined in:** [dialog.ts:40](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L40)
 
 ### `MessageDialogOptions`
 
@@ -103,23 +103,23 @@ Filter name.
 
 The label of the confirm button.
 
-**Defined in:** [dialog.ts:101](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/dialog.ts#L101)
+**Defined in:** [dialog.ts:101](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L101)
 
 ##### `title`
 
 > `Optional` **title**: `string`
 
 The title of the dialog. Defaults to the app name.
 
-**Defined in:** [dialog.ts:97](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/dialog.ts#L97)
+**Defined in:** [dialog.ts:97](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L97)
 
 ##### `type`
 
 > `Optional` **type**: `"info"` \| `"warning"` \| `"error"`
 
 The type of the dialog. Defaults to `info`.
 
-**Defined in:** [dialog.ts:99](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/dialog.ts#L99)
+**Defined in:** [dialog.ts:99](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L99)
 
 ### `OpenDialogOptions`
 
@@ -135,31 +135,31 @@ Options for the open dialog.
 
 Initial directory or file path.
 
-**Defined in:** [dialog.ts:62](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/dialog.ts#L62)
+**Defined in:** [dialog.ts:62](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L62)
 
 ##### `directory`
 
 > `Optional` **directory**: `boolean`
 
 Whether the dialog is a directory selection or not.
 
-**Defined in:** [dialog.ts:66](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/dialog.ts#L66)
+**Defined in:** [dialog.ts:66](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L66)
 
 ##### `filters`
 
 > `Optional` **filters**: [`DialogFilter`](dialog.md#dialogfilter)[]
 
 The filters of the dialog.
 
-**Defined in:** [dialog.ts:60](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/dialog.ts#L60)
+**Defined in:** [dialog.ts:60](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L60)
 
 ##### `multiple`
 
 > `Optional` **multiple**: `boolean`
 
 Whether the dialog allows multiple selection or not.
 
-**Defined in:** [dialog.ts:64](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/dialog.ts#L64)
+**Defined in:** [dialog.ts:64](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L64)
 
 ##### `recursive`
 
@@ -168,15 +168,15 @@ Whether the dialog allows multiple selection or not.
 If `directory` is true, indicates that it will be read recursively later.
 Defines whether subdirectories will be allowed on the scope or not.
 
-**Defined in:** [dialog.ts:71](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/dialog.ts#L71)
+**Defined in:** [dialog.ts:71](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L71)
 
 ##### `title`
 
 > `Optional` **title**: `string`
 
 The title of the dialog window.
 
-**Defined in:** [dialog.ts:58](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/dialog.ts#L58)
+**Defined in:** [dialog.ts:58](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L58)
 
 ### `SaveDialogOptions`
 
@@ -194,23 +194,23 @@ Initial directory or file path.
 If it's a directory path, the dialog interface will change to that folder.
 If it's not an existing directory, the file name will be set to the dialog's file name input and the dialog will be set to the parent folder.
 
-**Defined in:** [dialog.ts:89](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/dialog.ts#L89)
+**Defined in:** [dialog.ts:89](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L89)
 
 ##### `filters`
 
 > `Optional` **filters**: [`DialogFilter`](dialog.md#dialogfilter)[]
 
 The filters of the dialog.
 
-**Defined in:** [dialog.ts:83](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/dialog.ts#L83)
+**Defined in:** [dialog.ts:83](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L83)
 
 ##### `title`
 
 > `Optional` **title**: `string`
 
 The title of the dialog window.
 
-**Defined in:** [dialog.ts:81](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/dialog.ts#L81)
+**Defined in:** [dialog.ts:81](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L81)
 
 ## Functions