Skip to content

MenuEntry

type MenuEntry =
    | MenuPage of path: string
    | MenuSection of label: string * items: MenuItem list
    | MenuGroup of page: string * items: MenuItem list
    | MenuLink of label: string * url: string
AssemblyNacara.Theme.Default

What a menu entry points at.

Cases

MenuPage of path: string

A page of a collection, referenced by the path of its source file.

MenuSection of label: string * items: MenuItem list

A label over a set of entries. At the top of a menu it is a heading; nested, it folds.

MenuGroup of page: string * items: MenuItem list

A group whose label is a page of its own - the overview of what it holds.

The page takes the group's place rather than sitting inside it. Put it at index.md beside the pages it introduces and it keeps their url.

MenuLink of label: string * url: string

Properties

member IsMenuGroup: bool
member IsMenuLink: bool
member IsMenuPage: bool
member IsMenuSection: bool