starlight-cannoli-plugins 2.7.0 → 2.7.1

package/dist/index.d.ts

@@ -13,6 +13,12 @@ import 'vfile';
 import 'mdast';
 import 'expressive-code';
 
+type TBadgeVariant = "note" | "danger" | "success" | "caution" | "tip" | "default";
+type TIndexMarker = {
+    text: string;
+    variant: TBadgeVariant;
+};
+
 type TOptions = {
     /**
      * Controls how deep the nested group structure can go, where the root directory is level 0.
@@ -32,7 +38,13 @@ type TOptions = {
      * regular sidebar entries. When undefined, no marker is added.
      * @example "★"
      */
-    indexMarker?: string;
+    indexMarker?: TIndexMarker;
+    /**
+     * Whether sidebar groups should be collapsed by default. Starlight automatically expands
+     * the group containing the current page regardless of this setting.
+     * @default true
+     */
+    collapsed?: boolean;
 };
 /**
  * Starlight plugin that generates a sidebar by parsing markdown links from index.md files.

package/dist/index.js

@@ -110,7 +110,7 @@ function tryResolveMarkdownFile(href, currentDir) {
   }
   return findMarkdownFile(resolved);
 }
-function buildItems(dirPath, currentDepth, maxDepth, visited, indexMarker) {
+function buildItems(dirPath, currentDepth, maxDepth, visited, indexMarker, collapsed) {
   const absDir = path.resolve(dirPath);
   if (visited.has(absDir)) return [];
   visited.add(absDir);
@@ -125,8 +125,9 @@ function buildItems(dirPath, currentDepth, maxDepth, visited, indexMarker) {
   const items = [];
   const indexBaseLabel = fm.title ?? pathSegmentToLabel(path.basename(absDir));
   items.push({
-    label: indexMarker ? `${indexMarker} ${indexBaseLabel}` : indexBaseLabel,
-    slug: normalizeSlug(filePathToSlug(indexFile))
+    label: indexBaseLabel,
+    slug: normalizeSlug(filePathToSlug(indexFile)),
+    ...indexMarker && { badge: indexMarker }
   });
   for (const href of extractMarkdownLinks(indexFile)) {
     if (isExternal(href)) continue;
@@ -143,8 +144,9 @@ function buildItems(dirPath, currentDepth, maxDepth, visited, indexMarker) {
           continue;
         const subBaseLabel = subFm.title ?? pathSegmentToLabel(path.basename(subDirPath));
         items.push({
-          label: indexMarker ? `${indexMarker} ${subBaseLabel}` : subBaseLabel,
-          slug: normalizeSlug(filePathToSlug(resolvedFile))
+          label: subBaseLabel,
+          slug: normalizeSlug(filePathToSlug(resolvedFile)),
+          ...indexMarker && { badge: indexMarker }
         });
       } else {
         const subItems = buildItems(
@@ -152,7 +154,8 @@ function buildItems(dirPath, currentDepth, maxDepth, visited, indexMarker) {
           currentDepth + 1,
           maxDepth,
           visited,
-          indexMarker
+          indexMarker,
+          collapsed
         );
         if (subItems.length === 0) continue;
         if (currentDepth + 1 >= maxDepth) {
@@ -160,7 +163,8 @@ function buildItems(dirPath, currentDepth, maxDepth, visited, indexMarker) {
         } else {
           items.push({
             label: pathSegmentToLabel(path.basename(subDirPath)),
-            items: subItems
+            items: subItems,
+            collapsed
           });
         }
       }
@@ -178,7 +182,7 @@ function buildItems(dirPath, currentDepth, maxDepth, visited, indexMarker) {
   }
   return items;
 }
-function getIndexSourcedSidebarItems(directory, maxDepthNesting = 100, indexMarker) {
+function getIndexSourcedSidebarItems(directory, maxDepthNesting = 100, indexMarker, collapsed = true) {
   const absDir = path.resolve(directory);
   const rootGroupLabel = pathSegmentToLabel(path.basename(absDir));
   const items = buildItems(
@@ -186,10 +190,11 @@ function getIndexSourcedSidebarItems(directory, maxDepthNesting = 100, indexMark
     0,
     maxDepthNesting,
     /* @__PURE__ */ new Set(),
-    indexMarker
+    indexMarker,
+    collapsed
   );
   if (items.length === 0) return [];
-  return [{ label: rootGroupLabel, items }];
+  return [{ label: rootGroupLabel, items, collapsed }];
 }
 
 // src/plugins/starlight-index-sourced-sidebar/index.ts
@@ -200,13 +205,14 @@ function starlightIndexSourcedSidebar(options) {
     hooks: {
       "config:setup": (hookOptions) => {
         const { updateConfig } = hookOptions;
-        const { directories, maxDepthNesting = 100, indexMarker } = options;
+        const { directories, maxDepthNesting = 100, indexMarker, collapsed = true } = options;
         const sidebarItems = directories.map((directory) => {
           const dirPath = join2(SITE_DOCS_ROOT2, directory);
           const rawItems = getIndexSourcedSidebarItems(
             dirPath,
             maxDepthNesting,
-            indexMarker
+            indexMarker,
+            collapsed
           );
           const rootGroup = rawItems[0];
           if (!rootGroup || !("items" in rootGroup)) return void 0;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "starlight-cannoli-plugins",
   "type": "module",
-  "version": "2.7.0",
+  "version": "2.7.1",
   "description": "Starlight plugins for automatic sidebar generation and link validation",
   "license": "ISC",
   "main": "./dist/index.js",