This repository contains the source files for the documentation of UXP. It consumes the md files generated from the internal torq-native repository.
It isn't intended to be hosted by itself but instead should be imported into host-specific documentation for applications providing UXP-based extensibility (such as Photoshop and XD)
The documentation is based on the AdobeDocs/dev-site-documentation-template.
This repo is run manually and locally to pull in markdowns generated from torq-native using JSDocs.
- You must first ensure that the markdowns in
torq-nativeare available locally on your machine. - Create an .env file and define UXP_REPO_SOURCE_DOCS pointing to the markdown folder. Example
UXP_REPO_SOURCE_DOCS="<path-to-torq-native>/docs/dist"
- Run
npm run prepare-docsto copy over the files.
- Transclusions play an important role when the content from this repo has to be imported into
AdobeDocs/uxp-photoshop,AdobeDocs/uxp-xd, andAdobeDocs/uxp-indesign. It carries the reference to the actual markdown content insidesrc/pages. uxp_documentationis the alias name given to this repo when it is referred from other repos mentioned above.- It carries references to pages in
src/pageslocation
The side navigation panel in the devsite is generated from the reference-*.js files.