From ce9302793081e16d08e49c9f6b577d95e842de71 Mon Sep 17 00:00:00 2001 From: Mark Dumay <61946753+markdumay@users.noreply.github.com> Date: Tue, 10 Mar 2026 07:46:07 +0100 Subject: [PATCH] docs: update block args to snake_case and bump exampleSite dependency Replace hyphenated block argument names with snake_case equivalents across all block and component documentation pages. Bump exampleSite dependency from v1.6.0 to v1.6.2. Co-Authored-By: Claude Sonnet 4.6 --- content/blocks/_index.md | 6 +++--- content/blocks/about.md | 4 ++-- content/blocks/articles.md | 28 ++++++++++++++-------------- content/blocks/cards.md | 4 ++-- content/blocks/cta.md | 2 +- content/blocks/menu.md | 12 ++++++------ content/blocks/panels.md | 8 ++++---- content/blocks/team.md | 4 ++-- content/blocks/video-message.md | 8 ++++---- content/components/_index.md | 6 +++--- exampleSite/go.mod | 2 +- exampleSite/go.sum | 2 ++ 12 files changed, 44 insertions(+), 42 deletions(-) diff --git a/content/blocks/_index.md b/content/blocks/_index.md index 6c2c291..4fe1e23 100644 --- a/content/blocks/_index.md +++ b/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 --- diff --git a/content/blocks/about.md b/content/blocks/about.md index e712a0e..647b132 100644 --- a/content/blocks/about.md +++ b/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: #! diff --git a/content/blocks/articles.md b/content/blocks/articles.md index cfe7ab7..5aee14b 100644 --- a/content/blocks/articles.md +++ b/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. {{< 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. {{< 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 ``` diff --git a/content/blocks/cards.md b/content/blocks/cards.md index 3b33f07..e445e1a 100644 --- a/content/blocks/cards.md +++ b/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: diff --git a/content/blocks/cta.md b/content/blocks/cta.md index 9696ecb..f65f66a 100644 --- a/content/blocks/cta.md +++ b/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 diff --git a/content/blocks/menu.md b/content/blocks/menu.md index 2b2fae9..799209e 100644 --- a/content/blocks/menu.md +++ b/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 >}} diff --git a/content/blocks/panels.md b/content/blocks/panels.md index af97404..f496e0b 100644 --- a/content/blocks/panels.md +++ b/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 diff --git a/content/blocks/team.md b/content/blocks/team.md index 67ae4dc..29a478d 100644 --- a/content/blocks/team.md +++ b/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 diff --git a/content/blocks/video-message.md b/content/blocks/video-message.md index a8be9ae..bb79a3b 100644 --- a/content/blocks/video-message.md +++ b/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: diff --git a/content/components/_index.md b/content/components/_index.md index b69fb3f..49da974 100644 --- a/content/components/_index.md +++ b/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 --- diff --git a/exampleSite/go.mod b/exampleSite/go.mod index c7cfa07..cf2768f 100644 --- a/exampleSite/go.mod +++ b/exampleSite/go.mod @@ -2,4 +2,4 @@ module github.com/gethinode/mod-docs-example go 1.19 -require github.com/gethinode/mod-docs v1.6.0 // indirect +require github.com/gethinode/mod-docs v1.6.2 // indirect diff --git a/exampleSite/go.sum b/exampleSite/go.sum index a528a95..c9fb8ed 100644 --- a/exampleSite/go.sum +++ b/exampleSite/go.sum @@ -16,3 +16,5 @@ github.com/gethinode/mod-docs v1.5.0 h1:CGwaApo+xNkiZUYHd8Y8ZJmPTjoEDOYrnfxZuYtY github.com/gethinode/mod-docs v1.5.0/go.mod h1:ru1w0fHqFocjDIMV0dm40OwhBw5k4UncCS8iO/1S5kI= github.com/gethinode/mod-docs v1.6.0 h1:RXsY+TFuy8ScCI+e5/HDDiIt5usu5jhokDmqJ9pZpxw= github.com/gethinode/mod-docs v1.6.0/go.mod h1:ru1w0fHqFocjDIMV0dm40OwhBw5k4UncCS8iO/1S5kI= +github.com/gethinode/mod-docs v1.6.2 h1:aO5IMoXmn5gQHoR9JOX3sZU4ZhKsujbjDDN8YRt+j8c= +github.com/gethinode/mod-docs v1.6.2/go.mod h1:ru1w0fHqFocjDIMV0dm40OwhBw5k4UncCS8iO/1S5kI=