normalizePages
Function
Exported from nextra/normalize-pages
.
Signature
Parameters:Name | Type | Default |
---|---|---|
[0].list | PageMapItem[] | |
[0].route | string | |
[0].docsRoot | string | |
[0].underCurrentDocsRoot | boolean | |
[0].pageThemeContext.breadcrumb | boolean | undefined | |
[0].pageThemeContext.collapsed | boolean | undefined | |
[0].pageThemeContext.footer | boolean | undefined | |
[0].pageThemeContext.layout | "default" | "full" | undefined | |
[0].pageThemeContext.navbar | boolean | undefined | |
[0].pageThemeContext.pagination | boolean | undefined | |
[0].pageThemeContext.sidebar | boolean | undefined | |
[0].pageThemeContext.timestamp | boolean | undefined | |
[0].pageThemeContext.toc | boolean | undefined | |
[0].pageThemeContext.typesetting | "default" | "article" | undefined |
Name | Type |
---|---|
activeType | "page" | "doc" | "menu" Active type for current page, used to determine layout in theme. |
activeIndex | number Active index for current page, used for pagination in combination with |
activeThemeContext.breadcrumb | boolean | undefined |
activeThemeContext.collapsed | boolean | undefined |
activeThemeContext.footer | boolean | undefined |
activeThemeContext.layout | "default" | "full" | undefined |
activeThemeContext.navbar | boolean | undefined |
activeThemeContext.pagination | boolean | undefined |
activeThemeContext.sidebar | boolean | undefined |
activeThemeContext.timestamp | boolean | undefined |
activeThemeContext.toc | boolean | undefined |
activeThemeContext.typesetting | "default" | "article" | undefined |
activeMetadata | FrontMatter Parsed front matter or exported Metadata from page. |
activePath | Item[] Active path for current page, used for breadcrumb navigation. |
directories | Item[] All directories in the tree structure. |
docsDirectories | DocsItem[] Directories with |
flatDocsDirectories | DocsItem[] Flattened directories with |
topLevelNavbarItems | (PageItem | MenuItem)[] Navbar items, items which have |