Skip to content

commerce-docs/commerce-extensibility

 
 

Repository files navigation

Adobe Commerce Extensibility Developer Documentation

Welcome! This site contains the latest Adobe Commerce extensibility developer documentation for ongoing releases.

Local development

This is a Gatsby project that uses the Adobe I/O Theme.

To build the site locally:

  1. Clone this repo.

  2. Install project dependencies.

    yarn install
  3. Launch the project in development mode.

    yarn dev

Components

To achieve specific user experience goals for Commerce documentation, this repo overrides the original Edition component from the upstream aio-theme repo that we use as a dependency.

Edition

The custom Edition component in this repo displays a badge indicating whether a feature or functionality is available in specific Adobe Commerce environments. It has been customized to align with the badges that we use in Experience League docs.

Usage

# Page-level (metadata)
edition: saas # For SaaS-only features
edition: paas # For PaaS-only features
<!-- Section-level (inline) -->
<Edition name="paas" />  <!-- For PaaS-only features -->
<Edition name="saas" />  <!-- For SaaS-only features -->

Resources

See the following resources to learn more about using the theme:

If you have questions, open an issue and ask us. We look forward to hearing from you!