Skip to content

Commit

Permalink
first draft of new docs v2
Browse files Browse the repository at this point in the history
  • Loading branch information
Steve Kwak committed Jul 18, 2019
1 parent 321d662 commit afb3818
Show file tree
Hide file tree
Showing 6 changed files with 5,877 additions and 22 deletions.
46 changes: 24 additions & 22 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,32 +77,16 @@
* [How to show an alert](./tutorials/how-to-show-an-alert/index.md)
* [Asking user for confirmation](./tutorials/how-to-ask-user-for-confirmation/index.md)
* [Technical Reference](./reference/index.md)
* [API references](./reference/how-to-read.md)
* [How to read this reference](./reference/how-to-read.md)
* [application](./reference/application.md)
* [assets](./reference/assets.md)
* [clipboard](./reference/clipboard.md)
* [cloud](./reference/cloud.md)
* [interactions](./reference/interactions.md)
* [commands](./reference/commands.md)
* [scenegraph](./reference/scenegraph.md)
* [SceneNodeList](./reference/SceneNodeList.md)
* [Color](./reference/Color.md)
* [ImageFill](./reference/ImageFill.md)
* [LinearGradientFill](./reference/LinearGradientFill.md)
* [Matrix](./reference/Matrix.md)
* [Shadow](./reference/Shadow.md)
* [Blur](./reference/Blur.md)
* [selection](./reference/selection.md)
* [viewport](./reference/viewport.md)
* [OS](./reference/uxp/class/OS.md)
* [Storage APIs](./reference/uxp/storage-index.md)
* [Storage module](./reference/uxp/module/storage.md)
* [API references](./reference/reference-index.md)
* [UXP](./reference/uxp/index.md)
* [Network APIs](./reference/uxp/network-index.md)
* [XMLHttpRequest](./reference/uxp/class/XMLHttpRequest.md)
* [fetch](./reference/uxp/function/fetch.md)
* [WebSocket](./reference/uxp/class/WebSocket.md)
* [openExternal](./reference/uxp/class/Shell.md)
* [Storage APIs](./reference/uxp/storage-index.md)
* [Storage module](./reference/uxp/module/storage.md)
* [Shell](./reference/uxp/class/Shell.md)
* [OS](./reference/uxp/class/OS.md)
* [UI APIs](./reference/uxp/ui-index.md)
* [CSS support](./reference/uxp/namespace/css.md)
* [Classes](./reference/uxp/ui-classes-index.md)
Expand Down Expand Up @@ -155,6 +139,24 @@
* [MessageEvent](./reference/uxp/class/MessageEvent.md)
* [PointerEvent](./reference/uxp/class/PointerEvent.md)
* [ProgressEvent](./reference/uxp/class/ProgressEvent.md)
* [Host](./reference/xd-index.md)
* [scenegraph](./reference/scenegraph.md)
* [SceneNodeList](./reference/SceneNodeList.md)
* [Color](./reference/Color.md)
* [ImageFill](./reference/ImageFill.md)
* [LinearGradientFill](./reference/LinearGradientFill.md)
* [Matrix](./reference/Matrix.md)
* [Shadow](./reference/Shadow.md)
* [Blur](./reference/Blur.md)
* [selection](./reference/selection.md)
* [application](./reference/application.md)
* [assets](./reference/assets.md)
* [clipboard](./reference/clipboard.md)
* [cloud](./reference/cloud.md)
* [interactions](./reference/interactions.md)
* [commands](./reference/commands.md)
* [viewport](./reference/viewport.md)
* [How to read this reference](./reference/how-to-read.md)
* [Known issues](./known-issues.md)
* [Change log](./changes.md)
* [Glossary](./GLOSSARY.md)
Expand Down
Binary file added images/uxpandhost.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions reference/reference-index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# API References

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.

- [UXP APIs](/reference/uxp/index.md)
- [Host APIs](xd-index.md)

![UXP and host APIs](/images/uxpandhost.png)

Read ["How to read the reference documentation"](/reference/how-to-read.md) to learn how to read symbols inside the docs.
9 changes: 9 additions & 0 deletions reference/uxp/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Unified Extensibility Platform (UXP)

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:

- [Network](/reference/uxp/network-index.md)
- [Storage](/reference/uxp/storage-index.md)
- [Shell](/reference/uxp/module/shell.md)
- [OS](/reference/uxp/module/os.md)
- [UI](/reference/uxp/ui-index.md)
12 changes: 12 additions & 0 deletions reference/xd-index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Host APIs

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.

- [scenegraph](/reference/scnegraph.md)
- [application](/reference/application.md)
- [assets](/reference/assets.md)
- [clipboard](/reference/clipboard.md)
- [cloud](/reference/cloud.md)
- [interactions](/reference/interactions.md)
- [commands](/reference/commands.md)
- [viewport](/reference/ciewport.md)
Loading

0 comments on commit afb3818

Please sign in to comment.