This site contains the latest Adobe Commerce and Magento Open Source developer documentation for ongoing releases of Commerce Cloud Tools, including:
- Cloud Docker—For the Cloud Docker for Commerce source code, see the magento-cloud-docker repository.
Our goal is to provide the Adobe Commerce and Magento Open Source communities with comprehensive and quality technical documentation. We believe that to accomplish that goal we need experts from the community to share their knowledge with us and each other. We are thankful to all of our contributors for improving the documentation.
See the Contribution Guide for details about contributing to Adobe Commerce and Magento Open Source developer documentation.
This repository is a Gatsby project that uses the Adobe I/O Theme.
Install the following for local documentation site builds:
To build and serve the site:
-
Clone the repository and change to site directory.
-
Enable the
corepackpackage.corepack enable -
Set
yarnto stable version and install.yarn set version stableyarn install
-
Build site dependencies.
The
buildcommand is useful for refreshing the build artifacts without serving the site, butyarn devperforms this step.yarn build
-
Build site and serve preview on
localhost.yarn dev
Use CTRL + C to stop serving the site.
-
Clean local build artifacts.
yarn clean
| Command | Description |
|---|---|
yarn build |
Compile site files. |
yarn clean |
Clean build artifacts. |
yarn dev |
Launch dev server preview. |
yarn serve |
Serve the existing site files for testing preview. |
yarn start |
Compile site files and serve for testing preview. |
yarn test:links |
Test for broken links. |
See the following resources to learn more about using the theme:
- Arranging content structure
- Linking to pages
- Using assets
- Configuring global navigation
- Configuring side navigation
- Using content blocks
- Writing enhanced Markdown
- Deploying the site (Adobe employees only)
If you have questions, open an issue and ask us. We look forward to hearing from you!