@eryx/eryxdoc/render/sidebar Module

JSON

API Reference

Types

SidebarEntry
name: string
displayName: string
filename: string?
children: { SidebarEntry }?
isOpen: boolean
isActive: boolean

ArticleSidebarEntry
displayName: string
sitePath: string?
isActive: boolean
isOpen: boolean
children: { ArticleSidebarEntry }?

ArticleSidebarSection
title: string
entries: { ArticleSidebarEntry }

ArticleSidebarResult
topLevel: { ArticleSidebarEntry }

Loose top-level articles — displayed as bare links, not in any section

sections: { ArticleSidebarSection }

Top-level folders, each as a titled section