This is a Gatsby site template built with Adobe I/O Gatsby 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 :
$ npm install
$ npm run dev
If you have a M1 mac. You need to install vips before npm install
. Run
brew install vips
For running API doc locally
Modify src/pages/api/index.md to point openAPISpec to your local swagger.json
openAPISpec: /swagger.json
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.
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.