Merge pull request #31 from gethinode/develop

docs: update block args to snake_case and bump exampleSite dependency

Author: markdumay

content/blocks/_index.md

@@ -19,7 +19,7 @@ content_blocks:
     breadcrumb: true
 
   - _bookshop_name: articles
-    hide-empty: false
+    hide_empty: false
     input:
       reverse: false
       sort: title
@@ -30,7 +30,7 @@ content_blocks:
     paginate: true
     pagination: 25
     cover: false
-    header-style: none
-    body-style: minimal
+    header_style: none
+    body_style: minimal
     class: card-minimal
 ---

content/blocks/about.md

@@ -82,7 +82,7 @@ Set `link-type` to `link` to add links below the content.
     image: /img/placeholder.png
     ratio: 1x1
   order: first
-  link-type: link
+  link_type: link
   links:
     - title: First link
       url: #!
@@ -115,7 +115,7 @@ Set `link-type` to `button` to add buttons below the content. You can adjust the
     image: /img/placeholder.png
     ratio: 1x1
   order: first
-  link-type: button
+  link_type: button
   links:
     - title: Primary button
       url: #!

content/blocks/articles.md

@@ -26,8 +26,8 @@ The `articles` block renders a group of cards for selected content. By default,
     section: blog
     reverse: false
     sort: date
-  hide-empty: false
-  header-style: none
+  hide_empty: false
+  header_style: none
   orientation: stacked
   more:
     title: More Blogs
@@ -59,9 +59,9 @@ Set `orientation` to `horizontal` to render the article's illustration before th
     section: blog
     reverse: false
     sort: date
-  hide-empty: false
-  header-style: none
-  body-style: title
+  hide_empty: false
+  header_style: none
+  body_style: title
   orientation: horizontal
   more:
     title: More Blogs
@@ -79,7 +79,7 @@ Set `orientation` to `horizontal` to render the article's illustration before th
 
 ### Rich cards
 
-Adjust the `header-style`, `body-style`, and `footer-style` to refine the card elements being displayed.
+Adjust the `header_style`, `body_style`, and `footer_style` to refine the card elements being displayed.
 
 <!-- markdownlint-disable MD037 -->
 {{< example-bookshop lang="bookshop" >}}
@@ -93,10 +93,10 @@ Adjust the `header-style`, `body-style`, and `footer-style` to refine the card e
     section: blog
     reverse: false
     sort: date
-  hide-empty: false
-  header-style: publication
-  body-style: full
-  footer-style: tags
+  hide_empty: false
+  header_style: publication
+  body_style: full
+  footer_style: tags
   orientation: stacked
   more:
     title: More Blogs
@@ -114,14 +114,14 @@ Adjust the `header-style`, `body-style`, and `footer-style` to refine the card e
 
 ### Minimal cards
 
-Set `body-style` to `minimal` to show the title of an article only. The predefined `class` attribute `card-minimal` applies an underline effect on hover.
+Set `body_style` to `minimal` to show the title of an article only. The predefined `class` attribute `card-minimal` applies an underline effect on hover.
 
 <!-- markdownlint-disable MD037 -->
 {{< example-bookshop lang="bookshop" >}}
 
 ```yml
 - _bookshop_name: articles
-  hide-empty: false
+  hide_empty: false
   input:
     section: blog
     reverse: false
@@ -131,8 +131,8 @@ Set `body-style` to `minimal` to show the title of an article only. The predefin
   cols: 5
   padding: 0
   cover: false
-  header-style: none
-  body-style: minimal
+  header_style: none
+  body_style: minimal
   class: card-minimal
 ```
 

content/blocks/cards.md

@@ -95,7 +95,7 @@ Set the `icon` attribute of each `element` to an icon to render illustrated card
     color: body-tertiary
     subtle: false
   orientation: stacked
-  icon-style: text-primary
+  icon_style: text-primary
   align: start
   padding: 0
   elements:
@@ -131,7 +131,7 @@ Set the `icon` attribute of each `element` to an icon to render illustrated card
     color: body-tertiary
     subtle: false
   orientation: horizontal
-  icon-style: text-primary
+  icon_style: text-primary
   align: start
   padding: 0
   elements:

content/blocks/cta.md

@@ -63,7 +63,7 @@ Provide a `contact` person to include the name and thumbnail of a contact person
 ```yml
 - _bookshop_name: cta
   contact: Betty White
-  caption-url: https://gethinode.com
+  caption_url: https://gethinode.com
   background:
     color: body-tertiary
     subtle: false

content/blocks/menu.md

@@ -20,9 +20,9 @@ Set `menu-style` to `grid` to render a responsive menu as a grid.
 ```yml
   - _bookshop_name: menu
     menu: services
-    menu-style: grid
-    icon-rounded: true
-    icon-style: fa-1x
+    menu_style: grid
+    icon_rounded: true
+    icon_style: fa-1x
 ```
 
 {{< /example-bookshop >}}
@@ -38,9 +38,9 @@ Set `menu-style` to `masonry` to render a responsive menu using masonry style.
 ```yml
   - _bookshop_name: menu
     menu: services
-    menu-style: masonry
-    icon-rounded: true
-    icon-style: fa-1x
+    menu_style: masonry
+    icon_rounded: true
+    icon_style: fa-1x
 ```
 
 {{< /example-bookshop >}}

content/blocks/panels.md

@@ -28,7 +28,7 @@ Set `tab-type` to `tabs` to adjust the panel controls.
     color: body-tertiary
     subtle: false
   width: 12
-  tab-type: tabs
+  tab_type: tabs
   ratio: 1x1
   elements:
     - title: First Panel
@@ -63,7 +63,7 @@ Set `tab-type` to `pills` to adjust the panel controls.
     color: body-tertiary
     subtle: false
   width: 12
-  tab-type: pills
+  tab_type: pills
   ratio: 1x1
   elements:
     - title: First Panel
@@ -98,7 +98,7 @@ Set `tab-type` to `underline` to adjust the panel controls.
     color: body-tertiary
     subtle: false
   width: 12
-  tab-type: underline
+  tab_type: underline
   ratio: 1x1
   elements:
     - title: First Panel
@@ -133,7 +133,7 @@ Set `tab-type` to `callout` to adjust the panel controls.
     color: body-tertiary
     subtle: false
   width: 12
-  tab-type: callout
+  tab_type: callout
   ratio: 1x1
   elements:
     - title: First Panel

content/blocks/team.md

@@ -23,8 +23,8 @@ The `team` content block renders a group of team members.
     reverse: false
     sort: title
   cols: 3
-  hide-empty: false
-  header-style: none
+  hide_empty: false
+  header_style: none
   padding: 0
   background:
     color: body-tertiary

content/blocks/video-message.md

@@ -29,10 +29,10 @@ Set `orientation` to `horizontal` to display the messages to the right of the vi
     color: body-tertiary
     subtle: false
   orientation: horizontal
-  icon-style: fa-lg
+  icon_style: fa-lg
   video:
     provider: vimeo
-    media-id: "55073825"
+    media_id: "55073825"
     autoplay: true
     color: black
   messages:
@@ -65,10 +65,10 @@ Set `orientation` to `stacked` to display the messages below the video.
     color: body-tertiary
     subtle: false
   orientation: stacked
-  icon-style: fa-lg
+  icon_style: fa-lg
   video:
     provider: vimeo
-    media-id: "55073825"
+    media_id: "55073825"
     autoplay: true
     color: black
   messages:

content/components/_index.md

@@ -20,7 +20,7 @@ content_blocks:
     breadcrumb: true
 
   - _bookshop_name: articles
-    hide-empty: false
+    hide_empty: false
     input:
       reverse: false
       sort: title
@@ -31,7 +31,7 @@ content_blocks:
     paginate: true
     pagination: 50
     cover: false
-    header-style: none
-    body-style: minimal
+    header_style: none
+    body_style: minimal
     class: card-minimal
 ---