GeneratedNavigationNode
laika.directive.std.NavigationTreeDirectives$.GeneratedNavigationNode
case class GeneratedNavigationNode(target: VirtualPath, title: Option[SpanSequence], depth: Option[Int], excludeRoot: Option[Boolean], excludeSections: Option[Boolean]) extends NavigationNodeConfig
The configuration for an automatically generated navigation tree.
Value parameters
- depth
-
the depth to recurse from the root node
- excludeRoot
-
indicates whether the root node should be excluded in which case the first-level children will be inserted into the parent node
- excludeSections
-
indicates whether sections within documents should be excluded in automatic entries
- target
-
the target to use as the root node for navigation tree based on a relative or absolute path in the virtual input tree
- title
-
the title for this entry when getting rendered as a link
Attributes
- Graph
-
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait NavigationNodeConfigclass Objecttrait Matchableclass Any
Members list
In this article