From 699018d38ecb748a977e924773df6823500dd5ab Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Mon, 18 Nov 2024 06:55:47 -0800 Subject: [PATCH] Rename adding-installing-new-block.md to integrate-new-block.md Tidy up html_meta Add MyST markup --- .../adding-installing-new-block.md | 39 ------------------- docs/customizing-volto-light-theme/index.md | 2 +- .../integrate-new-block.md | 38 ++++++++++++++++++ 3 files changed, 39 insertions(+), 40 deletions(-) delete mode 100644 docs/customizing-volto-light-theme/adding-installing-new-block.md create mode 100644 docs/customizing-volto-light-theme/integrate-new-block.md diff --git a/docs/customizing-volto-light-theme/adding-installing-new-block.md b/docs/customizing-volto-light-theme/adding-installing-new-block.md deleted file mode 100644 index 7f5363b9..00000000 --- a/docs/customizing-volto-light-theme/adding-installing-new-block.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -myst: - html_meta: - "description": "Adding Installing New Block" - "property=og:description": "Adding Installing New Block" - "property=og:title": "Adding Installing New Block" - "keywords": "Plone, Volto, Training" ---- - - -# Adding a New Block - -In this training module, we'll learn how to integrate the @plone-collective/volto-relateditems-block into VLT. This block allows you to easily create links to related content in your Plone site. - -## Installing *@plone-collective/volto-relateditems-block* - -To install the related items block, make sure you are in the `frontend/packages/volto-my-project` folder, and use the following command: - -```shell -pnpm install @plone-collective/volto-relateditems-block -``` - -After installation, ensure that the addon is included in the addons key of your project's package.json: - -```json - "addons": [ - "@eeacms/volto-accordion-block", - "@kitconcept/volto-button-block", - "@kitconcept/volto-heading-block", - "@kitconcept/volto-highlight-block", - "@kitconcept/volto-introduction-block", - "@kitconcept/volto-separator-block", - "@kitconcept/volto-slider-block", - "@plone-collective/volto-relateditems-block", - "@kitconcept/volto-light-theme" - ], -``` - - That's it! Your project should now be using @plone-collective/volto-relateditems-block, which shows related items for the content as a list of links. \ No newline at end of file diff --git a/docs/customizing-volto-light-theme/index.md b/docs/customizing-volto-light-theme/index.md index 9e9b85f1..74e39816 100644 --- a/docs/customizing-volto-light-theme/index.md +++ b/docs/customizing-volto-light-theme/index.md @@ -30,7 +30,7 @@ This training is best suited for developers who have prior experience with Volto concepts creating-new-project installing-vlt -adding-installing-new-block +integrate-new-block theming question-answer ``` \ No newline at end of file diff --git a/docs/customizing-volto-light-theme/integrate-new-block.md b/docs/customizing-volto-light-theme/integrate-new-block.md new file mode 100644 index 00000000..3d745619 --- /dev/null +++ b/docs/customizing-volto-light-theme/integrate-new-block.md @@ -0,0 +1,38 @@ +--- +myst: + html_meta: + "description": "Adding New Block" + "property=og:description": "Adding New Block" + "property=og:title": "Adding New Block" + "keywords": "Plone, Volto, Training, Volto Light Theme, Integrate, block" +--- + +# Integrate a new block + +In this training module, we'll learn how to integrate the `@plone-collective/volto-relateditems-block` into VLT. This block allows you to create links to related content in your Plone site. + +## Install `@plone-collective/volto-relateditems-block` + +To install the related items block, make sure you are in the {file}`frontend/packages/volto-my-project` folder, and use the following command: + +```shell +pnpm install @plone-collective/volto-relateditems-block +``` + +After installation, ensure that the add-on is included in the `addons` key of your project's {file}`package.json`: + +```json +"addons": [ + "@eeacms/volto-accordion-block", + "@kitconcept/volto-button-block", + "@kitconcept/volto-heading-block", + "@kitconcept/volto-highlight-block", + "@kitconcept/volto-introduction-block", + "@kitconcept/volto-separator-block", + "@kitconcept/volto-slider-block", + "@plone-collective/volto-relateditems-block", + "@kitconcept/volto-light-theme" +], +``` + +That's it! Your project should now be using `@plone-collective/volto-relateditems-block`, which shows related items for the content as a list of links.