@eryxdoc/render/sidebar Module
API Reference
Types
SidebarEntry
type SidebarEntry = {
name: string,
displayName: string,
filename: string?,
sitePath: string?,
children: { SidebarEntry }?,
isOpen: boolean,
isActive: boolean
}
name: string
displayName: string
filename: string?
sitePath: string?
isOpen: boolean
isActive: boolean
ArticleSidebarEntry
type ArticleSidebarEntry = {
displayName: string,
sitePath: string?,
isActive: boolean,
isOpen: boolean,
children: { ArticleSidebarEntry }?
}
displayName: string
sitePath: string?
isActive: boolean
isOpen: boolean
ArticleSidebarSection
title: string
sitePath: string?
ArticleSidebarResult
type ArticleSidebarResult = {
topLevel: { ArticleSidebarEntry },
sections: { ArticleSidebarSection }
}
Loose top-level articles — displayed as bare links, not in any section
Top-level folders, each as a titled section