Skip to content

Commit 9a9a039

Browse files
author
Cari Spruiell
authored
Merge pull request #145 from magento-obsessive-owls/MC-4248-add-liquid-tags
MC-4248: Add liquid tags to docs
2 parents 7b2b6df + 8e94846 commit 9a9a039

30 files changed

+173
-10
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Contributing to Magento 2 code
22

3+
<!--{% comment %}-->
34
## Navigation
45

56
1. [Introduction]
@@ -18,7 +19,9 @@
1819
[Developer documentation]: docs/developer-documentation.md
1920
[Roadmap and Known Issues]: docs/roadmap.md
2021
[How to create custom PageBuilder content type container]: docs/how-to-create-custom-content-type-container.md
22+
<!--{% endcomment %}-->
2123

24+
<!-- {% raw %} -->
2225
## Overview
2326

2427
Contributions to the Magento 2 codebase are done using the fork & pull model.
@@ -56,3 +59,5 @@ If you are a new GitHub user, we recommend that you create your own [free github
5659

5760
Please note that this project is released with a Contributor Code of Conduct. We expect you to agree to its terms when participating in this project.
5861
The full text is available in the repository [Wiki](https://github.com/magento/magento2/wiki/Magento-Code-of-Conduct).
62+
63+
<!-- {% endraw %} -->

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# magento2-page-builder
22

3+
<!-- {% raw %} -->
4+
35
## PageBuilder Early Access Program
46

57
The PageBuilder Early Access Program (EAP) gives partners the following perks:
@@ -86,4 +88,6 @@ To participate in technical discussions and ask questions, join us in [Slack].
8688
For all other questions or requests, contact [Olena Tkacheva].
8789

8890
[Slack]: https://magentocommeng.slack.com/
89-
[Olena Tkacheva]: https://magentocommeng.slack.com/messages/@UAFV915FB
91+
[Olena Tkacheva]: https://magentocommeng.slack.com/messages/@UAFV915FB
92+
93+
<!-- {% endraw %} -->

docs/activation-deactivation.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
## Activate and Deactivate PageBuilder
22

3+
<!--{% comment %}-->
34
## Navigation
45

56
1. [Introduction]
@@ -59,8 +60,9 @@
5960
[Roadmap and Known Issues]: roadmap.md
6061
[How to create custom PageBuilder content type container]: how-to-create-custom-content-type-container.md
6162
[Activate and Deactivate PageBuilder]: activation-deactivation.md
63+
<!--{% endcomment %}-->
6264

63-
65+
<!-- {% raw %} -->
6466
## Activate PageBuilder
6567

6668
Follow these steps to activate PageBuilder in the Admin:
@@ -80,3 +82,5 @@ If you disabled or uninstalled the entire PageBuilder module instead of just the
8082

8183
1. Implement PageBuilder widgets and initialize them on dynamic blocks since JavaScript functionality provided by PageBuilder will no longer work.
8284
2. Change the layout in the database for entities that use the full width layout to prevent blank layout content.
85+
86+
<!-- {% endraw %} -->

docs/add-custom-logic.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Add custom logic to content types
22

3+
<!--{% comment %}-->
34
## Navigation
45

56
1. [Introduction]
@@ -57,7 +58,9 @@
5758
[Add custom logic to content types]: add-custom-logic.md
5859
[Roadmap and Known Issues]: roadmap.md
5960
[How to create custom PageBuilder content type container]: how-to-create-custom-content-type-container.md
61+
<!--{% endcomment %}-->
6062

63+
<!-- {% raw %} -->
6164
You can customize PageBuilder content types by adding your own logic on the frontend.
6265

6366
To add custom logic to content types:
@@ -131,4 +134,6 @@ Add the following configuration to the `etc/di.xml` file in your custom module d
131134
</argument>
132135
</arguments>
133136
</type>
134-
```
137+
```
138+
139+
<!-- {% endraw %} -->

docs/architecture-overview.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Architecture overview
22

3+
<!--{% comment %}-->
34
## Navigation
45

56
1. [Introduction]
@@ -57,8 +58,9 @@
5758
[Add custom logic to content types]: add-custom-logic.md
5859
[Roadmap and Known Issues]: roadmap.md
5960
[How to create custom PageBuilder content type container]: how-to-create-custom-content-type-container.md
61+
<!--{% endcomment %}-->
6062

61-
63+
<!-- {% raw %} -->
6264
## What is PageBuilder?
6365

6466
PageBuilder is tool that simplifies content creation by letting you drag and drop content types and configure them without writing a line of code.
@@ -185,3 +187,5 @@ Appearances allow you to make the following customization on existing content ty
185187
[TypeScript]: https://www.typescriptlang.org/
186188
[master format]: master-format.md
187189
[content type]: how-to-add-new-content-type.md
190+
191+
<!-- {% endraw %} -->

docs/bindings.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Bindings
22

3+
<!--{% comment %}-->
34
## Navigation
45

56
1. [Introduction]
@@ -57,8 +58,9 @@
5758
[Add custom logic to content types]: add-custom-logic.md
5859
[Roadmap and Known Issues]: roadmap.md
5960
[How to create custom PageBuilder content type container]: how-to-create-custom-content-type-container.md
61+
<!--{% endcomment %}-->
6062

61-
63+
<!-- {% raw %} -->
6264
## Summary
6365

6466
As part of the Page Builder application, we provide new Knockout bindings you can use in your custom content types:
@@ -106,3 +108,4 @@ Example Usage:
106108
app/code/Magento/PageBuilder/view/adminhtml/web/template/panel.html
107109
```
108110

111+
<!-- {% endraw %} -->

docs/block-chooser-component.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Use the block chooser UI component
22

3+
<!--{% comment %}-->
34
## Navigation
45

56
1. [Introduction]
@@ -57,19 +58,23 @@
5758
[Add custom logic to content types]: add-custom-logic.md
5859
[Roadmap and Known Issues]: roadmap.md
5960
[How to create custom PageBuilder content type container]: how-to-create-custom-content-type-container.md
61+
<!--{% endcomment %}-->
6062

63+
<!-- {% raw %} -->
6164
## What's in this topic
6265

6366
This topic describes how to use the block chooser UI component for a custom content type.
6467

6568
## Overview
69+
6670
To use the block chooser component for your custom content type:
6771

6872
1. [Add the block select grid listing modal to content type XML](#add-the-block-select-grid-listing-modal-to-content-type-XML)
6973
2. [Add component to content type XML](#add-component-to-content-type-xml)
7074

7175

7276
## Configuration options
77+
7378
Extends all `abstract` configuration.
7479

7580
`Magento_PageBuilder/js/form/element/block-chooser` configuration options:
@@ -190,3 +195,5 @@ To insert the block chooser UI component, `Magento_PageBuilder/js/form/element/b
190195
The `block_id` field pulls in the selected value from the modal.
191196

192197
Then the `block_chooser` component pulls in the value from the `block_id` field to ascertain when it should commence updating.
198+
199+
<!-- {% endraw %} -->

docs/bluefoot-data-migration.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# BlueFoot to PageBuilder data migration
22

3+
<!--{% comment %}-->
34
## Navigation
45

56
1. [Introduction]
@@ -57,8 +58,9 @@
5758
[Add custom logic to content types]: add-custom-logic.md
5859
[Roadmap and Known Issues]: roadmap.md
5960
[How to create custom PageBuilder content type container]: how-to-create-custom-content-type-container.md
61+
<!--{% endcomment %}-->
6062

61-
63+
<!-- {% raw %} -->
6264
## Overview
6365

6466
This topic goes over the data migration process for BlueFoot data into the PageBuilder module in Magento 2.3.
@@ -308,3 +310,5 @@ If you are creating a new renderer for migration outside the PageBuilder module,
308310
[lifecycle]: https://devdocs.magento.com/guides/v2.2/extension-dev-guide/prepare/lifecycle.html
309311
[`di.xml`]: https://devdocs.magento.com/guides/v2.2/extension-dev-guide/build/di-xml-file.html
310312
[dependency injection]: https://devdocs.magento.com/guides/v2.2/extension-dev-guide/depend-inj.html
313+
314+
<!-- {% endraw %} -->

docs/content-type-configuration.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
**Note:**
44
*We are revising configuration, format will change. We will publish draft of new improved configuration soon to get feedback.*
55

6+
<!--{% comment %}-->
67
## Navigation
78

89
1. [Introduction]
@@ -60,7 +61,9 @@
6061
[Add custom logic to content types]: add-custom-logic.md
6162
[Roadmap and Known Issues]: roadmap.md
6263
[How to create custom PageBuilder content type container]: how-to-create-custom-content-type-container.md
64+
<!--{% endcomment %}-->
6365

66+
<!-- {% raw %} -->
6467
## Configuration
6568

6669
Use the content type and group configuration to add new content types, extend existing content types, add groups in the left menu, or rearrange content types in the groups.
@@ -558,3 +561,4 @@ define([], function () {
558561
| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | -------------- |
559562
|`fieldsToIgnoreOnRemove`| array containing field names to ignore when evaluating whether an element has been configured. The default value is an empty array. | `["tab_name"]` |
560563

564+
<!-- {% endraw %} -->

docs/content-type-preview.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Render a backend content type preview
22

3+
<!--{% comment %}-->
34
## Navigation
45

56
1. [Introduction]
@@ -57,8 +58,11 @@
5758
[Add custom logic to content types]: add-custom-logic.md
5859
[Roadmap and Known Issues]: roadmap.md
5960
[How to create custom PageBuilder content type container]: how-to-create-custom-content-type-container.md
61+
<!--{% endcomment %}-->
6062

63+
<!-- {% raw %} -->
6164
## What's in this topic
65+
6266
This topic describes how to use the `RenderPool` on the stage to render a backend [content type] preview.
6367

6468
Using this method, you can preview content types that cannot be rendered on the stage and require further backend processing to be previewed.
@@ -155,4 +159,4 @@ Generally, you would perform this operation when the properties change, by overr
155159

156160
To update the Document Object Model (DOM) to display your content, amend the JavaScript property that represents the HTML variable of your main element with the response from the HTTP request, `this.data.main.html(response.content);` from the previous example.
157161

158-
162+
<!-- {% endraw %} -->

0 commit comments

Comments
 (0)