From 70fdaa1d4cbfd1a20d720ab626864b7b3bb7b5f9 Mon Sep 17 00:00:00 2001 From: Shaun Struwig <41984034+Blargian@users.noreply.github.com> Date: Sat, 17 May 2025 10:32:52 +0200 Subject: [PATCH 1/3] support hN level headers for vertical stepper --- .../{partionning_keys.md => partitioning_keys.mdx} | 0 plugins/remark-custom-blocks.js | 11 +++++++++-- sidebars.js | 2 +- src/components/Stepper/Stepper.tsx | 4 ++-- 4 files changed, 12 insertions(+), 5 deletions(-) rename docs/best-practices/{partionning_keys.md => partitioning_keys.mdx} (100%) diff --git a/docs/best-practices/partionning_keys.md b/docs/best-practices/partitioning_keys.mdx similarity index 100% rename from docs/best-practices/partionning_keys.md rename to docs/best-practices/partitioning_keys.mdx diff --git a/plugins/remark-custom-blocks.js b/plugins/remark-custom-blocks.js index 80ce19852d2..5e857e05d20 100644 --- a/plugins/remark-custom-blocks.js +++ b/plugins/remark-custom-blocks.js @@ -37,8 +37,15 @@ const plugin = (options) => { if (attr.name === 'type' && typeof attr.value === 'string') { type = attr.value; } else if (attr.name === 'headerLevel' && typeof attr.value === 'string') { - if (attr.value === "h3") - headerLevel = 3 + let set_level = attr.value + const regex = /h([2-5])/; + const match = set_level.match(regex); + // If there's a match, convert the captured group to a number + if (match) { + headerLevel = Number(match[1]); + } else { + throw new Error("VerticalStepper supported only for h2-5"); + } } } }); diff --git a/sidebars.js b/sidebars.js index c6056a3a2f2..9e08ac22806 100644 --- a/sidebars.js +++ b/sidebars.js @@ -89,7 +89,7 @@ const sidebars = { "best-practices/select_data_type", "best-practices/use_materialized_views", "best-practices/minimize_optimize_joins", - "best-practices/partionning_keys", + "best-practices/partitioning_keys", "best-practices/selecting_an_insert_strategy", "best-practices/using_data_skipping_indices", "best-practices/avoid_mutations", diff --git a/src/components/Stepper/Stepper.tsx b/src/components/Stepper/Stepper.tsx index ad8765d9269..715e3a31550 100644 --- a/src/components/Stepper/Stepper.tsx +++ b/src/components/Stepper/Stepper.tsx @@ -89,8 +89,8 @@ const VStepper = ({ const isExpandedMode = expanded === 'true'; let hType = 'h2'; - if (headerLevel == 3) { - hType = 'h3' + if (headerLevel > 2) { + hType = `h${headerLevel}` } // Get children and filter out non-elements From 7b4faf0c21c8a1f79aaeacc12dcda71f6af02d68 Mon Sep 17 00:00:00 2001 From: Shaun Struwig <41984034+Blargian@users.noreply.github.com> Date: Sat, 17 May 2025 11:24:54 +0200 Subject: [PATCH 2/3] rename import --- docs/guides/best-practices/partitioningkey.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/best-practices/partitioningkey.md b/docs/guides/best-practices/partitioningkey.md index 86e2a4c9e3f..e3b3bd864cc 100644 --- a/docs/guides/best-practices/partitioningkey.md +++ b/docs/guides/best-practices/partitioningkey.md @@ -5,6 +5,6 @@ title: 'Choose a Low Cardinality Partitioning Key' description: 'Use a low cardinality partitioning key or avoid using any partitioning key for your table.' --- -import Content from '@site/docs/best-practices/partionning_keys.md'; +import Content from '@site/docs/best-practices/partitioning_keys.md'; From 318cb65c73c079f3deac232d9fabfe42ac8d9f5c Mon Sep 17 00:00:00 2001 From: Shaun Struwig <41984034+Blargian@users.noreply.github.com> Date: Mon, 19 May 2025 12:53:36 +0200 Subject: [PATCH 3/3] Fix broken links --- docs/guides/best-practices/partitioningkey.md | 2 +- docusaurus.config.en.js | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/guides/best-practices/partitioningkey.md b/docs/guides/best-practices/partitioningkey.md index e3b3bd864cc..a41fa1bf3eb 100644 --- a/docs/guides/best-practices/partitioningkey.md +++ b/docs/guides/best-practices/partitioningkey.md @@ -5,6 +5,6 @@ title: 'Choose a Low Cardinality Partitioning Key' description: 'Use a low cardinality partitioning key or avoid using any partitioning key for your table.' --- -import Content from '@site/docs/best-practices/partitioning_keys.md'; +import Content from '@site/docs/best-practices/partitioning_keys.mdx'; diff --git a/docusaurus.config.en.js b/docusaurus.config.en.js index 26d71d10010..a3339e8ace8 100644 --- a/docusaurus.config.en.js +++ b/docusaurus.config.en.js @@ -60,10 +60,10 @@ const config = { // url: process.env.VERCEL_URL ? `https://${process.env.VERCEL_URL}` : 'https://bookish-disco-5997zvo.pages.github.io', baseUrl: "/docs/", baseUrlIssueBanner: true, - onBrokenLinks: "warn", + onBrokenLinks: "throw", onBrokenMarkdownLinks: "warn", onDuplicateRoutes: "throw", - onBrokenAnchors: "warn", + onBrokenAnchors: "throw", favicon: "img/docs_favicon.ico", organizationName: "ClickHouse", trailingSlash: false,