Skip to content

Commit afb3818

Browse files
author
Steve Kwak
committed
first draft of new docs v2
1 parent 321d662 commit afb3818

File tree

6 files changed

+5877
-22
lines changed

6 files changed

+5877
-22
lines changed

SUMMARY.md

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -77,32 +77,16 @@
7777
* [How to show an alert](./tutorials/how-to-show-an-alert/index.md)
7878
* [Asking user for confirmation](./tutorials/how-to-ask-user-for-confirmation/index.md)
7979
* [Technical Reference](./reference/index.md)
80-
* [API references](./reference/how-to-read.md)
81-
* [How to read this reference](./reference/how-to-read.md)
82-
* [application](./reference/application.md)
83-
* [assets](./reference/assets.md)
84-
* [clipboard](./reference/clipboard.md)
85-
* [cloud](./reference/cloud.md)
86-
* [interactions](./reference/interactions.md)
87-
* [commands](./reference/commands.md)
88-
* [scenegraph](./reference/scenegraph.md)
89-
* [SceneNodeList](./reference/SceneNodeList.md)
90-
* [Color](./reference/Color.md)
91-
* [ImageFill](./reference/ImageFill.md)
92-
* [LinearGradientFill](./reference/LinearGradientFill.md)
93-
* [Matrix](./reference/Matrix.md)
94-
* [Shadow](./reference/Shadow.md)
95-
* [Blur](./reference/Blur.md)
96-
* [selection](./reference/selection.md)
97-
* [viewport](./reference/viewport.md)
98-
* [OS](./reference/uxp/class/OS.md)
99-
* [Storage APIs](./reference/uxp/storage-index.md)
100-
* [Storage module](./reference/uxp/module/storage.md)
80+
* [API references](./reference/reference-index.md)
81+
* [UXP](./reference/uxp/index.md)
10182
* [Network APIs](./reference/uxp/network-index.md)
10283
* [XMLHttpRequest](./reference/uxp/class/XMLHttpRequest.md)
10384
* [fetch](./reference/uxp/function/fetch.md)
10485
* [WebSocket](./reference/uxp/class/WebSocket.md)
105-
* [openExternal](./reference/uxp/class/Shell.md)
86+
* [Storage APIs](./reference/uxp/storage-index.md)
87+
* [Storage module](./reference/uxp/module/storage.md)
88+
* [Shell](./reference/uxp/class/Shell.md)
89+
* [OS](./reference/uxp/class/OS.md)
10690
* [UI APIs](./reference/uxp/ui-index.md)
10791
* [CSS support](./reference/uxp/namespace/css.md)
10892
* [Classes](./reference/uxp/ui-classes-index.md)
@@ -155,6 +139,24 @@
155139
* [MessageEvent](./reference/uxp/class/MessageEvent.md)
156140
* [PointerEvent](./reference/uxp/class/PointerEvent.md)
157141
* [ProgressEvent](./reference/uxp/class/ProgressEvent.md)
142+
* [Host](./reference/xd-index.md)
143+
* [scenegraph](./reference/scenegraph.md)
144+
* [SceneNodeList](./reference/SceneNodeList.md)
145+
* [Color](./reference/Color.md)
146+
* [ImageFill](./reference/ImageFill.md)
147+
* [LinearGradientFill](./reference/LinearGradientFill.md)
148+
* [Matrix](./reference/Matrix.md)
149+
* [Shadow](./reference/Shadow.md)
150+
* [Blur](./reference/Blur.md)
151+
* [selection](./reference/selection.md)
152+
* [application](./reference/application.md)
153+
* [assets](./reference/assets.md)
154+
* [clipboard](./reference/clipboard.md)
155+
* [cloud](./reference/cloud.md)
156+
* [interactions](./reference/interactions.md)
157+
* [commands](./reference/commands.md)
158+
* [viewport](./reference/viewport.md)
159+
* [How to read this reference](./reference/how-to-read.md)
158160
* [Known issues](./known-issues.md)
159161
* [Change log](./changes.md)
160162
* [Glossary](./GLOSSARY.md)

images/uxpandhost.png

189 KB
Loading

reference/reference-index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# API References
2+
3+
There are two main types of APIs you can use to create your XD plugin. While Unified Extensibility Platform (UXP) provides commonly used APIs across different Creative Cloud applications, Host APIs enable developers to extend XD specific features.
4+
5+
- [UXP APIs](/reference/uxp/index.md)
6+
- [Host APIs](xd-index.md)
7+
8+
![UXP and host APIs](/images/uxpandhost.png)
9+
10+
Read ["How to read the reference documentation"](/reference/how-to-read.md) to learn how to read symbols inside the docs.

reference/uxp/index.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Unified Extensibility Platform (UXP)
2+
3+
Unified Extensibility Platform (UXP) is a new extensibility architecture that provides commonly used APIs across different Creative Cloud applications. These common APIs include File I/O, Network I/O, and a User Interface layer. In this API reference docs, we organized UXP APIs into three categories:
4+
5+
- [Network](/reference/uxp/network-index.md)
6+
- [Storage](/reference/uxp/storage-index.md)
7+
- [Shell](/reference/uxp/module/shell.md)
8+
- [OS](/reference/uxp/module/os.md)
9+
- [UI](/reference/uxp/ui-index.md)

reference/xd-index.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Host APIs
2+
3+
Host APIs enable developers to extend XD specific features. Using these APIs, developers can create plugins that create, read, update, and delete objects inside XD documents. Also, most other features available in XD, such as creating renditions, modifying assets panel, getting prototype data, conducting commands, and others are also available through these APIs.
4+
5+
- [scenegraph](/reference/scnegraph.md)
6+
- [application](/reference/application.md)
7+
- [assets](/reference/assets.md)
8+
- [clipboard](/reference/clipboard.md)
9+
- [cloud](/reference/cloud.md)
10+
- [interactions](/reference/interactions.md)
11+
- [commands](/reference/commands.md)
12+
- [viewport](/reference/ciewport.md)

0 commit comments

Comments
 (0)