This is a site template built with the Adobe I/O Theme.
View the demo running on Github Pages.
The slack channel #adobeio-onsite-onboarding is our main point of contact for help. Feel free to join the channel and ask any questions.
For local development, simply use :
$ yarn install
$ yarn dev
(also use yarn clean)
For the documentation developer, please read these sections on how to:
- Arrange the structure content of your docs
- Linking to pages
- Using assets
- Setting Global Navigation
- Setting Side Navigation
- Using content blocks
- Notes on using Markdown
For more in-depth instructions.
-
To run the configured linters locally (requires Docker):
yarn lint
NOTE If you cannot use Docker, you can install the linters separately. In
.github/super-linter.env, see which linters are enabled, and find the tools being used for linting in Supported Linters. -
To check internal links locally
yarn test:links
-
To build and preview locally:
yarn start
For any team that wishes to deploy to the adobe.io and stage.adobe.io website, they must be in contact with the dev-site team. Teams will be given a path that will follow the pattern adobe.io/{product}/. This will allow doc developers to setup their subpaths to look something like:
adobe.io/{product}/docs
adobe.io/{product}/community
adobe.io/{product}/community/code_of_conduct
adobe.io/{product}/community/contribute
You can deploy using the GitHub actions deploy workflow see deploy instructions.
We performed structural changes to this repo by moving some files into a different repo and setup the following redirections to avoid any bookmarks to break
https://developer-stage.adobe.com/indesign/uxp/omv/-> https://developer-stage.adobe.com/indesign/dom/api/https://developer-stage.adobe.com/indesign/uxp/uxp/*-> https://developer-stage.adobe.com/indesign/uxp/reference/uxp-api/*https://developer-stage.adobe.com/indesign/uxp/reference/uxp-scripting-samples/-> https://developer-stage.adobe.com/indesign/uxp/uxp-scripting-samples/https://developer.adobe.com/indesign/uxp/reference/recipes-> https://developer.adobe.com/indesign/uxp/recipes