Type Members

1.  case class GeneratedNavigationNode(target: PathBase, title: Option[SpanSequence] = None, depth: Option[Int] = None, excludeRoot: Option[Boolean] = None, excludeSections: Option[Boolean] = None) extends NavigationNodeConfig with Product with Serializable

   The configuration for an automatically generated navigation tree.

   The configuration for an automatically generated navigation tree.

   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

   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

2.  case class ManualNavigationNode(title: SpanSequence, target: Option[ExternalTarget] = None, children: Seq[NavigationNodeConfig] = Nil) extends NavigationNodeConfig with Product with Serializable

   The configuration for a manual entry in the navigation tree.

   The configuration for a manual entry in the navigation tree. The entry can have further children which may in turn be either manual or automatically generated nodes.

   title

   the title for this entry when getting rendered as a link

   target

   the external link for this node (if missing this node just generates a navigation header as a separator within the tree)

   children

   the children of this node, either manual or automatically generated

3.  case class NavigationBuilderConfig(entries: Seq[NavigationNodeConfig], source: SourceFragment, defaultDepth: Int = Int.MaxValue, itemStyles: Set[String] = Set(), excludeRoot: Boolean = false, excludeSections: Boolean = false, excludeSelf: Boolean = false, options: Options = NoOpt) extends Element with BlockResolver with Product with Serializable

   A block resolver that replaces itself with a navigation list according to this instances configuration.

   A block resolver that replaces itself with a navigation list according to this instances configuration. The resulting navigation tree can either be automatically generated from specified root nodes of the input tree or by specifying entries manually (or a combination of both).

   Serves as the implementation for the navigationTree directive, but can also be inserted into the AST manually.

   entries

   the list of manual and automatic entries to insert into the navigation tree

   source

   the source fragment that produced this navigation builder, for error reporting

   defaultDepth

   the depth for automatically generated entries (unless overridden in the entries' config)

   itemStyles

   the styles to apply to all navigation items in the list as a render hint

   excludeRoot

   indicates whether the root node should be excluded in automatic entries (may be overridden in the entries' config)

   excludeSections

   indicates whether sections within documents should be excluded in automatic entries (may be overridden in the entries' config)

   excludeSelf

   indicates whether the current document should be included

   options

   optional styles and/or an id for the final navigation list

4.  sealed trait NavigationNodeConfig extends AnyRef

   Represents the configuration for a single node in a navigation tree.