Skip to content

Commit fd168fd

Browse files
committed
MC-4248: Add liquid tags to docs
Added line returns after headings per PR review.
1 parent 1ef9d2d commit fd168fd

10 files changed

+24
-0
lines changed

docs/block-chooser-component.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,13 +66,15 @@
6666
This topic describes how to use the block chooser UI component for a custom content type.
6767

6868
## Overview
69+
6970
To use the block chooser component for your custom content type:
7071

7172
1. [Add the block select grid listing modal to content type XML](#add-the-block-select-grid-listing-modal-to-content-type-XML)
7273
2. [Add component to content type XML](#add-component-to-content-type-xml)
7374

7475

7576
## Configuration options
77+
7678
Extends all `abstract` configuration.
7779

7880
`Magento_PageBuilder/js/form/element/block-chooser` configuration options:

docs/events.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,7 @@ This document contains reference information for events dispatched in Page Build
101101
* [googleMaps:authFailure](#googlemapsauthFailure)
102102

103103
## `contentType:*` events
104+
104105
All events starting with `contentType:` can also be called for specific content types by prefixing the content types name (`{{name}}:{{event}}`) like the following:
105106
* `text:createAfter`
106107
* `row:mountAfter`

docs/full-width-page-layouts.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,18 +62,21 @@
6262

6363
<!-- {% raw %} -->
6464
## What's in this topic
65+
6566
This topic describes the new full-width page layouts in Page Builder, along with instructions on how you can use them in custom themes.
6667

6768
**Note:** These layouts use the Luma theme page structures. They may not work as expected in your custom themes.
6869

6970
## New Page Layout defaults
71+
7072
Page Builder sets the default layouts to the new full-width layouts supplied by our Page Builder module. So unless you change the page layout, new pages are full width by default.
7173

7274
![Page Layout Defaults](images/default-full-width.png)
7375

7476
**Note:** The full-width layouts are specific to Product, Category, and CMS Page. Using one of these layouts outside of its intended scope could yield unpredictable results.
7577

7678
## CMS Full Width
79+
7780
This template simply removes the left and right gutters from a CMS page's content. It is implemented with `cms-full-width.xml` and extends from the `1column` page layout.
7881

7982
As this template extends from the `1column` page layout we restore the `page-layout-1column` class within the `Magento\PageBuilder\Plugin\Result\Page` plugin.
@@ -87,6 +90,7 @@ We do this by referencing the `main.content` container and replacing the `page-m
8790
![CMS Full Width Layout](images/cms-full-width.png)
8891

8992
## Category Full Width
93+
9094
This template takes the `columns.top` section of the page and moves it out of the `main.content` section, allowing us to break out of the gutter to provide full width on just the description. It is implemented with `category-full-width.xml` and extends the `2columns-left` page layout.
9195

9296
As this template extends from the `2columns-left` page layout we restore the `page-layout-2columns-left` class within the `Magento\PageBuilder\Plugin\Result\Page` plugin.
@@ -114,6 +118,7 @@ We do this within `category-full-width.xml` by creating new wrapping containers
114118
![Category Full Width Layout](images/category-full-width.png)
115119

116120
## Product Full Width
121+
117122
This template takes the description out of the tabs section and moves it just above the reviews tab. It is implemented with `product-full-width.xml` and extends the `1column` page layout.
118123

119124
As this template extends from the `1column` page layout we restore the `page-layout-1column` class within the `Magento\PageBuilder\Plugin\Result\Page` plugin.
@@ -139,11 +144,13 @@ In `product-full-width.xml`, we create a new wrapper for product details & descr
139144
![Product Full Width Layout](images/product-full-width.png)
140145

141146
## Custom Theme Full Width
147+
142148
We cannot guarantee these full-width layouts will work as expected with your custom themes as your page's structure may differ from Luma's.
143149

144150
To enable full width within your custom themes, you must ensure the appropriate block is not within your page's main wrapper. This implementation will differ on a case-by-case basis but the above implementations for Luma should give you a good indication on how to approach these.
145151

146152
## Disabling Page Builder
153+
147154
If you apply one of our custom layouts to an entity and then disable or remove the Page Builder module you'll be required to manually update those entities with new page layouts. This is due to disabling Page Builder will make the new full width layouts unavailable thus causing entities to render incorrectly.
148155

149156
<!-- {% endraw %} -->

docs/iconography.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,13 +67,15 @@ PageBuilder Admin icons follow the same design principles as the core [Magento A
6767
They are simple, flat, and monochromatic to prevent the loss of detail at smaller sizes and makes the shapes easier to comprehend.
6868

6969
## Icon library
70+
7071
The following image shows all available PageBuilder Admin icons:
7172

7273
![PageBuilder admin icons](images/pagebuilder-icons.png)
7374

7475
You can use these icons when extending or customizing the PageBuilder module or [create your own icons].
7576

7677
## Icon fonts
78+
7779
We recommend using icon fonts to get the best quality for your icons.
7880
The PageBuilder Admin icon fonts can be found in the [cms-icons repository].
7981

docs/image-uploader.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@
6262

6363
<!-- {% raw %} -->
6464
## What's in this topic
65+
6566
This topic describes how to add a reusable image uploader component to the PageBuilder stage for a content type.
6667

6768
## Overview

docs/master-format.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ Contained:
7777
```
7878

7979
### wrapper element
80+
8081
1. data-element [main]
8182
2. data-role [row]
8283
3. data-appearance [contained]
@@ -186,6 +187,7 @@ Inline styles
186187
```
187188

188189
### main element
190+
189191
Attributes
190192
1. data-element [main, navigation, headers, content]
191193
2. data-role [tabs]
@@ -202,13 +204,15 @@ Inline styles
202204

203205

204206
### navigation element
207+
205208
Attributes
206209
1. data-element [navigation]
207210

208211
Inline styles
209212
1. text-align
210213

211214
### headers element
215+
212216
Attributes
213217
1. data-element [headers]
214218

@@ -218,6 +222,7 @@ Inline styles
218222
3. border-width
219223

220224
### content element
225+
221226
Attributes
222227
1. data-element [content]
223228

docs/product-conditions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@
6262

6363
<!-- {% raw %} -->
6464
## What's in this topic
65+
6566
This topic describes how use the product conditions rule tree for different content types. By reusing the conditions mechanism you can apply it to your own custom content types.
6667

6768
## Overview

docs/toolbar.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@
6262

6363
<!-- {% raw %} -->
6464
## What's in this topic
65+
6566
This document outlines how to add a custom toolbar in Page Builder. It's a simplified/lightweight version of a WYSIWYG:
6667
![Page Builder toolbar](images/toolbar.png)
6768

docs/visual-select.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@
6262

6363
<!-- {% raw %} -->
6464
## What's in this topic
65+
6566
This topic describes how to extend some Page Builder fields to accommodate a custom look and feel for the text alignment option.
6667

6768
The text alignment field for each content block, in the Advanced section, now shows an icon and title. You can customize the text alignment field to show this new look and feel for all content blocks.
@@ -139,6 +140,7 @@ Use a virtual type of `Magento\PageBuilder\Model\Source\VisualSelect` in your mo
139140
```
140141

141142
### Display notice when option is selected
143+
142144
For some options you may wish to display an additional notice when the user selects the item. You can do this by providing a `noticeMessage` within the items declaration.
143145
```xml
144146
<item name="3" xsi:type="array">
@@ -150,6 +152,7 @@ For some options you may wish to display an additional notice when the user sele
150152
```
151153

152154
## How to reuse vertical alignment between different content types {#vertical-alignment}
155+
153156
To apply vertical alignment to a content type using the Visual Select component, use the virtualType `Magento\PageBuilder\Model\Source\VerticalAlignment` with options in your module's `di.xml` configuration file.
154157

155158
```xml

docs/widget-directive.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@
6262

6363
<!-- {% raw %} -->
6464
## What's in this topic
65+
6566
This topic describes how to store a component's master format as a `widget-directive`.
6667

6768
## Overview

0 commit comments

Comments
 (0)