Skip to content

Commit 031c807

Browse files
Laegeltauri-bot
andauthored
Moving main docs to core repo (tauri-apps#228)
* feat: Added sidebars * warning: Added detached typedoc files * feat: Added version file * fix: Trim on version to avoid linebreaks * fix: Adapting to CI * chore(docs): Update Rust & TS docs (tauri-apps#230) Co-authored-by: Laegel <[email protected]> * chore(docs): Update Rust & TS docs (tauri-apps#231) Co-authored-by: Laegel <[email protected]> Co-authored-by: tauri <[email protected]> Co-authored-by: Laegel <[email protected]>
1 parent ff16c05 commit 031c807

File tree

233 files changed

+6889
-4576
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

233 files changed

+6889
-4576
lines changed

docs/en/api/config.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ It's composed of the following properties:
3939
## `package`
4040

4141
<Properties anchorRoot="package" rows={[
42-
{ property: "productName", optional: true, type: "string", description: `Application binary name. Converted to snake-case on Linux.` },
42+
{ property: "name", optional: true, type: "string", description: `Application binary name. Converted to snake-case on Linux.` },
4343
{ property: "version", optional: true, type: "string", description: `Application version.` }
4444
]}/>
4545

@@ -269,12 +269,6 @@ It's composed of the following properties:
269269
]}/>
270270
</Array>
271271
},
272-
{
273-
property: "systemTray", type: "object",
274-
child: <Properties anchorRoot="tauri.systemTray" rows={[
275-
{ property: "iconPath", type: "string", description: `The path of the icon to use on the system tray. On macOS and Linux, the ".png" extension is enforced; on Windows, a ".ico" file with the same name must exist.` }
276-
]}/>
277-
},
278272
{
279273
property: "security", type: "object",
280274
child: <Properties anchorRoot="tauri.security" rows={[

docs/en/api/js/classes/http.body.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
title: "Class: Body"
32
sidebar_label: "Body"
43
custom_edit_url: null
54
hide_title: true
@@ -17,15 +16,15 @@ The body object to be used on POST and PUT requests.
1716

1817
**payload**: *unknown*
1918

20-
Defined in: [http.ts:28](https://github.com/tauri-apps/tauri/blob/a68b4ee8/tooling/api/src/http.ts#L28)
19+
Defined in: [http.ts:45](https://github.com/tauri-apps/tauri/blob/3afef190/tooling/api/src/http.ts#L45)
2120

2221
___
2322

2423
### type
2524

2625
**type**: *string*
2726

28-
Defined in: [http.ts:27](https://github.com/tauri-apps/tauri/blob/a68b4ee8/tooling/api/src/http.ts#L27)
27+
Defined in: [http.ts:44](https://github.com/tauri-apps/tauri/blob/3afef190/tooling/api/src/http.ts#L44)
2928

3029
## Methods
3130

@@ -45,7 +44,7 @@ Name | Type |
4544

4645
The body object ready to be used on the POST and PUT requests.
4746

48-
Defined in: [http.ts:76](https://github.com/tauri-apps/tauri/blob/a68b4ee8/tooling/api/src/http.ts#L76)
47+
Defined in: [http.ts:93](https://github.com/tauri-apps/tauri/blob/3afef190/tooling/api/src/http.ts#L93)
4948

5049
___
5150

@@ -65,7 +64,7 @@ Name | Type | Description |
6564

6665
The body object ready to be used on the POST and PUT requests.
6766

68-
Defined in: [http.ts:43](https://github.com/tauri-apps/tauri/blob/a68b4ee8/tooling/api/src/http.ts#L43)
67+
Defined in: [http.ts:60](https://github.com/tauri-apps/tauri/blob/3afef190/tooling/api/src/http.ts#L60)
6968

7069
___
7170

@@ -85,7 +84,7 @@ Name | Type | Description |
8584

8685
The body object ready to be used on the POST and PUT requests.
8786

88-
Defined in: [http.ts:54](https://github.com/tauri-apps/tauri/blob/a68b4ee8/tooling/api/src/http.ts#L54)
87+
Defined in: [http.ts:71](https://github.com/tauri-apps/tauri/blob/3afef190/tooling/api/src/http.ts#L71)
8988

9089
___
9190

@@ -105,4 +104,4 @@ Name | Type |
105104

106105
The body object ready to be used on the POST and PUT requests.
107106

108-
Defined in: [http.ts:65](https://github.com/tauri-apps/tauri/blob/a68b4ee8/tooling/api/src/http.ts#L65)
107+
Defined in: [http.ts:82](https://github.com/tauri-apps/tauri/blob/3afef190/tooling/api/src/http.ts#L82)

docs/en/api/js/classes/http.client.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
title: "Class: Client"
32
sidebar_label: "Client"
43
custom_edit_url: null
54
hide_title: true
@@ -15,7 +14,7 @@ hide_title: true
1514

1615
**id**: *number*
1716

18-
Defined in: [http.ts:122](https://github.com/tauri-apps/tauri/blob/a68b4ee8/tooling/api/src/http.ts#L122)
17+
Defined in: [http.ts:139](https://github.com/tauri-apps/tauri/blob/3afef190/tooling/api/src/http.ts#L139)
1918

2019
## Methods
2120

@@ -42,7 +41,7 @@ Name | Type | Description |
4241

4342
A promise resolving to the response.
4443

45-
Defined in: [http.ts:239](https://github.com/tauri-apps/tauri/blob/a68b4ee8/tooling/api/src/http.ts#L239)
44+
Defined in: [http.ts:256](https://github.com/tauri-apps/tauri/blob/3afef190/tooling/api/src/http.ts#L256)
4645

4746
___
4847

@@ -54,7 +53,7 @@ Drops the client instance.
5453

5554
**Returns:** *Promise*<void\>
5655

57-
Defined in: [http.ts:133](https://github.com/tauri-apps/tauri/blob/a68b4ee8/tooling/api/src/http.ts#L133)
56+
Defined in: [http.ts:150](https://github.com/tauri-apps/tauri/blob/3afef190/tooling/api/src/http.ts#L150)
5857

5958
___
6059

@@ -81,7 +80,7 @@ Name | Type | Description |
8180

8281
A promise resolving to the response.
8382

84-
Defined in: [http.ts:167](https://github.com/tauri-apps/tauri/blob/a68b4ee8/tooling/api/src/http.ts#L167)
83+
Defined in: [http.ts:184](https://github.com/tauri-apps/tauri/blob/3afef190/tooling/api/src/http.ts#L184)
8584

8685
___
8786

@@ -108,7 +107,7 @@ Name | Type | Description |
108107

109108
A promise resolving to the response.
110109

111-
Defined in: [http.ts:224](https://github.com/tauri-apps/tauri/blob/a68b4ee8/tooling/api/src/http.ts#L224)
110+
Defined in: [http.ts:241](https://github.com/tauri-apps/tauri/blob/3afef190/tooling/api/src/http.ts#L241)
112111

113112
___
114113

@@ -136,7 +135,7 @@ Name | Type | Description |
136135

137136
A promise resolving to the response.
138137

139-
Defined in: [http.ts:183](https://github.com/tauri-apps/tauri/blob/a68b4ee8/tooling/api/src/http.ts#L183)
138+
Defined in: [http.ts:200](https://github.com/tauri-apps/tauri/blob/3afef190/tooling/api/src/http.ts#L200)
140139

141140
___
142141

@@ -164,7 +163,7 @@ Name | Type | Description |
164163

165164
A promise resolving to the response.
166165

167-
Defined in: [http.ts:204](https://github.com/tauri-apps/tauri/blob/a68b4ee8/tooling/api/src/http.ts#L204)
166+
Defined in: [http.ts:221](https://github.com/tauri-apps/tauri/blob/3afef190/tooling/api/src/http.ts#L221)
168167

169168
___
170169

@@ -190,4 +189,4 @@ Name | Type | Description |
190189

191190
A promise resolving to the response.
192191

193-
Defined in: [http.ts:149](https://github.com/tauri-apps/tauri/blob/a68b4ee8/tooling/api/src/http.ts#L149)
192+
Defined in: [http.ts:166](https://github.com/tauri-apps/tauri/blob/3afef190/tooling/api/src/http.ts#L166)

docs/en/api/js/classes/shell.child.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
title: "Class: Child"
32
sidebar_label: "Child"
43
custom_edit_url: null
54
hide_title: true
@@ -23,7 +22,7 @@ Name | Type |
2322

2423
**Returns:** [*Child*](shell.child.md)
2524

26-
Defined in: [shell.ts:115](https://github.com/tauri-apps/tauri/blob/a68b4ee8/tooling/api/src/shell.ts#L115)
25+
Defined in: [shell.ts:133](https://github.com/tauri-apps/tauri/blob/3afef190/tooling/api/src/shell.ts#L133)
2726

2827
## Properties
2928

@@ -33,7 +32,7 @@ Defined in: [shell.ts:115](https://github.com/tauri-apps/tauri/blob/a68b4ee8/too
3332

3433
The child process `pid`.
3534

36-
Defined in: [shell.ts:115](https://github.com/tauri-apps/tauri/blob/a68b4ee8/tooling/api/src/shell.ts#L115)
35+
Defined in: [shell.ts:133](https://github.com/tauri-apps/tauri/blob/3afef190/tooling/api/src/shell.ts#L133)
3736

3837
## Methods
3938

@@ -47,7 +46,7 @@ Kills the child process.
4746

4847
A promise indicating the success or failure of the operation.
4948

50-
Defined in: [shell.ts:151](https://github.com/tauri-apps/tauri/blob/a68b4ee8/tooling/api/src/shell.ts#L151)
49+
Defined in: [shell.ts:169](https://github.com/tauri-apps/tauri/blob/3afef190/tooling/api/src/shell.ts#L169)
5150

5251
___
5352

@@ -75,4 +74,4 @@ Name | Type | Description |
7574

7675
A promise indicating the success or failure of the operation.
7776

78-
Defined in: [shell.ts:135](https://github.com/tauri-apps/tauri/blob/a68b4ee8/tooling/api/src/shell.ts#L135)
77+
Defined in: [shell.ts:153](https://github.com/tauri-apps/tauri/blob/3afef190/tooling/api/src/shell.ts#L153)

docs/en/api/js/classes/shell.command.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
title: "Class: Command"
32
sidebar_label: "Command"
43
custom_edit_url: null
54
hide_title: true
@@ -52,7 +51,7 @@ Name | Type | Default value | Description |
5251

5352
Overrides: EventEmitter&lt;&#x27;close&#x27; | &#x27;error&#x27;&gt;.constructor
5453

55-
Defined in: [shell.ts:189](https://github.com/tauri-apps/tauri/blob/a68b4ee8/tooling/api/src/shell.ts#L189)
54+
Defined in: [shell.ts:207](https://github.com/tauri-apps/tauri/blob/3afef190/tooling/api/src/shell.ts#L207)
5655

5756
## Properties
5857

@@ -62,7 +61,7 @@ Defined in: [shell.ts:189](https://github.com/tauri-apps/tauri/blob/a68b4ee8/too
6261

6362
Event emitter for the `stderr`. Emits the `data` event.
6463

65-
Defined in: [shell.ts:189](https://github.com/tauri-apps/tauri/blob/a68b4ee8/tooling/api/src/shell.ts#L189)
64+
Defined in: [shell.ts:207](https://github.com/tauri-apps/tauri/blob/3afef190/tooling/api/src/shell.ts#L207)
6665

6766
___
6867

@@ -72,7 +71,7 @@ ___
7271

7372
Event emitter for the `stdout`. Emits the `data` event.
7473

75-
Defined in: [shell.ts:187](https://github.com/tauri-apps/tauri/blob/a68b4ee8/tooling/api/src/shell.ts#L187)
74+
Defined in: [shell.ts:205](https://github.com/tauri-apps/tauri/blob/3afef190/tooling/api/src/shell.ts#L205)
7675

7776
## Methods
7877

@@ -95,7 +94,7 @@ assert(output.stderr === '')
9594

9695
A promise resolving to the child process output.
9796

98-
Defined in: [shell.ts:274](https://github.com/tauri-apps/tauri/blob/a68b4ee8/tooling/api/src/shell.ts#L274)
97+
Defined in: [shell.ts:292](https://github.com/tauri-apps/tauri/blob/3afef190/tooling/api/src/shell.ts#L292)
9998

10099
___
101100

@@ -118,7 +117,7 @@ The `this` instance for chained calls.
118117

119118
Inherited from: EventEmitter.on
120119

121-
Defined in: [shell.ts:107](https://github.com/tauri-apps/tauri/blob/a68b4ee8/tooling/api/src/shell.ts#L107)
120+
Defined in: [shell.ts:125](https://github.com/tauri-apps/tauri/blob/3afef190/tooling/api/src/shell.ts#L125)
122121

123122
___
124123

@@ -132,7 +131,7 @@ Executes the command as a child process, returning a handle to it.
132131

133132
A promise resolving to the child process handle.
134133

135-
Defined in: [shell.ts:237](https://github.com/tauri-apps/tauri/blob/a68b4ee8/tooling/api/src/shell.ts#L237)
134+
Defined in: [shell.ts:255](https://github.com/tauri-apps/tauri/blob/3afef190/tooling/api/src/shell.ts#L255)
136135

137136
___
138137

@@ -158,4 +157,4 @@ Name | Type | Default value | Description |
158157

159158
**Returns:** [*Command*](shell.command.md)
160159

161-
Defined in: [shell.ts:222](https://github.com/tauri-apps/tauri/blob/a68b4ee8/tooling/api/src/shell.ts#L222)
160+
Defined in: [shell.ts:240](https://github.com/tauri-apps/tauri/blob/3afef190/tooling/api/src/shell.ts#L240)

docs/en/api/js/classes/window.logicalposition.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
title: "Class: LogicalPosition"
32
sidebar_label: "LogicalPosition"
43
custom_edit_url: null
54
hide_title: true
@@ -26,28 +25,28 @@ Name | Type |
2625

2726
**Returns:** [*LogicalPosition*](window.logicalposition.md)
2827

29-
Defined in: [window.ts:59](https://github.com/tauri-apps/tauri/blob/a68b4ee8/tooling/api/src/window.ts#L59)
28+
Defined in: [window.ts:76](https://github.com/tauri-apps/tauri/blob/3afef190/tooling/api/src/window.ts#L76)
3029

3130
## Properties
3231

3332
### type
3433

3534
**type**: *string*= 'Logical'
3635

37-
Defined in: [window.ts:57](https://github.com/tauri-apps/tauri/blob/a68b4ee8/tooling/api/src/window.ts#L57)
36+
Defined in: [window.ts:74](https://github.com/tauri-apps/tauri/blob/3afef190/tooling/api/src/window.ts#L74)
3837

3938
___
4039

4140
### x
4241

4342
**x**: *number*
4443

45-
Defined in: [window.ts:58](https://github.com/tauri-apps/tauri/blob/a68b4ee8/tooling/api/src/window.ts#L58)
44+
Defined in: [window.ts:75](https://github.com/tauri-apps/tauri/blob/3afef190/tooling/api/src/window.ts#L75)
4645

4746
___
4847

4948
### y
5049

5150
**y**: *number*
5251

53-
Defined in: [window.ts:59](https://github.com/tauri-apps/tauri/blob/a68b4ee8/tooling/api/src/window.ts#L59)
52+
Defined in: [window.ts:76](https://github.com/tauri-apps/tauri/blob/3afef190/tooling/api/src/window.ts#L76)

docs/en/api/js/classes/window.logicalsize.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
title: "Class: LogicalSize"
32
sidebar_label: "LogicalSize"
43
custom_edit_url: null
54
hide_title: true
@@ -26,28 +25,28 @@ Name | Type |
2625

2726
**Returns:** [*LogicalSize*](window.logicalsize.md)
2827

29-
Defined in: [window.ts:30](https://github.com/tauri-apps/tauri/blob/a68b4ee8/tooling/api/src/window.ts#L30)
28+
Defined in: [window.ts:47](https://github.com/tauri-apps/tauri/blob/3afef190/tooling/api/src/window.ts#L47)
3029

3130
## Properties
3231

3332
### height
3433

3534
**height**: *number*
3635

37-
Defined in: [window.ts:30](https://github.com/tauri-apps/tauri/blob/a68b4ee8/tooling/api/src/window.ts#L30)
36+
Defined in: [window.ts:47](https://github.com/tauri-apps/tauri/blob/3afef190/tooling/api/src/window.ts#L47)
3837

3938
___
4039

4140
### type
4241

4342
**type**: *string*= 'Logical'
4443

45-
Defined in: [window.ts:28](https://github.com/tauri-apps/tauri/blob/a68b4ee8/tooling/api/src/window.ts#L28)
44+
Defined in: [window.ts:45](https://github.com/tauri-apps/tauri/blob/3afef190/tooling/api/src/window.ts#L45)
4645

4746
___
4847

4948
### width
5049

5150
**width**: *number*
5251

53-
Defined in: [window.ts:29](https://github.com/tauri-apps/tauri/blob/a68b4ee8/tooling/api/src/window.ts#L29)
52+
Defined in: [window.ts:46](https://github.com/tauri-apps/tauri/blob/3afef190/tooling/api/src/window.ts#L46)

docs/en/api/js/classes/window.physicalposition.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
title: "Class: PhysicalPosition"
32
sidebar_label: "PhysicalPosition"
43
custom_edit_url: null
54
hide_title: true
@@ -26,31 +25,31 @@ Name | Type |
2625

2726
**Returns:** [*PhysicalPosition*](window.physicalposition.md)
2827

29-
Defined in: [window.ts:71](https://github.com/tauri-apps/tauri/blob/a68b4ee8/tooling/api/src/window.ts#L71)
28+
Defined in: [window.ts:88](https://github.com/tauri-apps/tauri/blob/3afef190/tooling/api/src/window.ts#L88)
3029

3130
## Properties
3231

3332
### type
3433

3534
**type**: *string*= 'Physical'
3635

37-
Defined in: [window.ts:69](https://github.com/tauri-apps/tauri/blob/a68b4ee8/tooling/api/src/window.ts#L69)
36+
Defined in: [window.ts:86](https://github.com/tauri-apps/tauri/blob/3afef190/tooling/api/src/window.ts#L86)
3837

3938
___
4039

4140
### x
4241

4342
**x**: *number*
4443

45-
Defined in: [window.ts:70](https://github.com/tauri-apps/tauri/blob/a68b4ee8/tooling/api/src/window.ts#L70)
44+
Defined in: [window.ts:87](https://github.com/tauri-apps/tauri/blob/3afef190/tooling/api/src/window.ts#L87)
4645

4746
___
4847

4948
### y
5049

5150
**y**: *number*
5251

53-
Defined in: [window.ts:71](https://github.com/tauri-apps/tauri/blob/a68b4ee8/tooling/api/src/window.ts#L71)
52+
Defined in: [window.ts:88](https://github.com/tauri-apps/tauri/blob/3afef190/tooling/api/src/window.ts#L88)
5453

5554
## Methods
5655

@@ -68,4 +67,4 @@ Name | Type |
6867

6968
**Returns:** [*LogicalPosition*](window.logicalposition.md)
7069

71-
Defined in: [window.ts:79](https://github.com/tauri-apps/tauri/blob/a68b4ee8/tooling/api/src/window.ts#L79)
70+
Defined in: [window.ts:96](https://github.com/tauri-apps/tauri/blob/3afef190/tooling/api/src/window.ts#L96)

0 commit comments

Comments
 (0)