Skip to Content
🎉 Nextra 4.0 is released. dimaMachina is looking for a new job or consulting .
APInormalizePages

normalizePages function

Exported from nextra/normalize-pages.

Signature

Parameters:
NameTypeDefault
[0].listPageMapItem[]
[0].routestring
[0].docsRootstring
[0].underCurrentDocsRootboolean
[0].pageThemeContext.paginationboolean | undefined
[0].pageThemeContext.breadcrumbboolean | undefined
[0].pageThemeContext.collapsedboolean | undefined
[0].pageThemeContext.footerboolean | undefined
[0].pageThemeContext.layout"default" | "full" | undefined
[0].pageThemeContext.navbarboolean | undefined
[0].pageThemeContext.sidebarboolean | undefined
[0].pageThemeContext.timestampboolean | undefined
[0].pageThemeContext.tocboolean | undefined
[0].pageThemeContext.typesetting"default" | "article" | undefined
Returns:
NameType
activeType"doc" | "page" | "menu"

Active type for current page, used to determine layout in theme.

activeIndexnumber

Active index for current page, used for pagination in combination with flatDocsDirectories items.

activeThemeContext.paginationboolean | undefined
activeThemeContext.breadcrumbboolean | undefined
activeThemeContext.collapsedboolean | undefined
activeThemeContext.footerboolean | undefined
activeThemeContext.layout"default" | "full" | undefined
activeThemeContext.navbarboolean | undefined
activeThemeContext.sidebarboolean | undefined
activeThemeContext.timestampboolean | undefined
activeThemeContext.tocboolean | undefined
activeThemeContext.typesetting"default" | "article" | undefined
activeMetadataFrontMatter

Parsed front matter  or exported Metadata  from page.

activePathItem[]

Active path for current page, used for breadcrumb navigation.

directoriesItem[]

All directories in the tree structure.

docsDirectoriesDocsItem[]

Directories with type: 'doc' in _meta file.

flatDocsDirectoriesDocsItem[]

Flattened directories with type: 'doc' in _meta file.

topLevelNavbarItems(PageItem | MenuItem)[]

Navbar items, items which have type: 'page' in _meta file.