navigation

.navigation role:{NavigationContainer.Role? = null} content:{MarkdownContent} -> Node

Creates a navigation container, which marks its content as a navigable section.

This doesn't affect the layout of the document by itself, but rather brings semantic meaning that can be used by themes and renderers to provide additional navigation features, styling, behaviors and accessibility.

For example, this can be useful in docs documents to mark sidebar navigation sections, in combination with pagemargin, in order to list links to subdocuments:

.pagemargin {lefttop}
.navigation role:{pagelist}
- [Page 1](page-1.qd)
- [Page 2](page-2.qd)

Return

a NavigationContainer node

Parameters

role
  • Optional

role of the navigation container

Values

content

content of the container