add support for unlisted docs in front matter (#928)

godaddy · Sep 25, 2024 · 71e69a1 · 71e69a1
1 parent 0b1e369
commit 71e69a1
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/scripts/generate-docs-index/utils/add-front-matter.js b/scripts/generate-docs-index/utils/add-front-matter.js
@@ -26,6 +26,9 @@ const frontMatterConfig = {
   'upgrades.md': {
     sidebar_position: 6
   },
+  'upgrade-to-6.md': {
+    unlisted: true
+  },
   'upgrade-to-7.md': {
     sidebar_position: 7
   },
@@ -62,6 +65,7 @@ export default function addFrontMatter(content, filename) {
   const frontMatter = {
     title: `''`, // empty title to remove redundant title
     hide_title: true,
+    unlisted: frontMatterConfig[filename]?.unlisted || false, // ability to hide from sidebar
     sidebar_label: frontMatterConfig[filename]?.label || `${formatFilename(filename)}`,
     sidebar_position: frontMatterConfig[filename]?.sidebar_position || 50
   };