hide library index in sidebar

Author: maxnorm

.github/scripts/generate-docs-utils/category/category-generator.js

@@ -312,17 +312,19 @@ function computeSlug(outputDir, libraryDir) {
  * @param {string} label - Category label
  * @param {string} description - Category description
  * @param {boolean} overwrite - Whether to overwrite existing files (default: false)
+ * @param {boolean} hideFromSidebar - Whether to hide the index page from sidebar (default: false)
  * @returns {boolean} True if file was created/updated, false if skipped
  */
-function createCategoryIndexFile(outputDir, relativePath, label, description, overwrite = false) {
+function createCategoryIndexFile(outputDir, relativePath, label, description, overwrite = false, hideFromSidebar = false) {
   return createIndexFile(
     outputDir,
     relativePath,
     label,
     description,
     generateLabel,
     generateDescription,
-    overwrite
+    overwrite,
+    hideFromSidebar
   );
 }
 
@@ -391,7 +393,9 @@ function ensureBaseCategory(libraryDir) {
   const description = 'API reference for all Compose modules and facets.';
 
   // Create index.mdx for base library category
-  createCategoryIndexFile(libraryDir, '', label, description, false);
+  // Hide from sidebar (sidebar_position: -1) so it doesn't appear as a duplicate
+  // The category link in _category_.json will still work
+  createIndexFile(libraryDir, '', label, description, generateLabel, generateDescription, false, true);
 
   const baseCategory = {
     label,

.github/scripts/generate-docs-utils/category/index-page-generator.js

@@ -108,14 +108,17 @@ function getCategoryItems(outputDir, relativePath, generateLabel, generateDescri
  * @param {Array} items - Array of items to display
  * @returns {string} Generated MDX content
  */
-function generateIndexMdxContent(label, description, items) {
+function generateIndexMdxContent(label, description, items, hideFromSidebar = false) {
   // Escape quotes in label and description for frontmatter
   const escapedLabel = label.replace(/"/g, '\\"');
   const escapedDescription = description.replace(/"/g, '\\"');
 
+  // Add sidebar_class_name: "hidden" to hide from sidebar if requested
+  const sidebarClass = hideFromSidebar ? '\nsidebar_class_name: "hidden"' : '';
+  
   let mdxContent = `---
 title: "${escapedLabel}"
-description: "${escapedDescription}"
+description: "${escapedDescription}"${sidebarClass}
 ---
 
 import DocCard, { DocCardGrid } from '@site/src/components/docs/DocCard';
@@ -174,7 +177,8 @@ function createCategoryIndexFile(
   description,
   generateLabel,
   generateDescription,
-  overwrite = false
+  overwrite = false,
+  hideFromSidebar = false
 ) {
   const indexFile = path.join(outputDir, 'index.mdx');
 
@@ -187,7 +191,7 @@ function createCategoryIndexFile(
   const items = getCategoryItems(outputDir, relativePath, generateLabel, generateDescription);
 
   // Generate MDX content
-  const mdxContent = generateIndexMdxContent(label, description, items);
+  const mdxContent = generateIndexMdxContent(label, description, items, hideFromSidebar);
 
   // Ensure directory exists
   fs.mkdirSync(outputDir, { recursive: true });