Skip to content

Commit 7697b91

Browse files
jeff-matthewscod62627
authored andcommitted
CCSAAS-2087: Added info about editions component'
1 parent bc83195 commit 7697b91

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,28 @@ To build the site locally:
2727
yarn dev
2828
```
2929

30+
## Components
31+
32+
To achieve specific user experience goals for Commerce documentation, this repo overrides the original [`Edition`](https://github.com/adobe/aio-theme/blob/main/packages/gatsby-theme-aio/src/components/Edition/index.js) component from the upstream [`aio-theme`](https://github.com/adobe/aio-theme/) repo that we use as a dependency.
33+
34+
### Edition
35+
36+
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.
37+
38+
#### Usage
39+
40+
```yaml
41+
# Page-level (metadata)
42+
edition: saas # For SaaS-only features
43+
edition: paas # For PaaS-only features
44+
```
45+
46+
```md
47+
<!-- Section-level (inline) -->
48+
<Edition name="paas" /> <!-- For PaaS-only features -->
49+
<Edition name="saas" /> <!-- For SaaS-only features -->
50+
```
51+
3052
## Resources
3153

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

0 commit comments

Comments
 (0)