laika-io
API
Generated with
laika-io/laika/laika.io/laika.io.model/RenderedDocument

RenderedDocument

laika.io.model.RenderedDocument
case class RenderedDocument(path: Path, title: Option[SpanSequence], sections: Seq[SectionInfo], content: String, config: Config) extends RenderContent, DocumentNavigation

A single rendered document with the content as a plain string in the target format.

The title and section info are still represented as an AST, so they be used in any subsequent step that needs to produce navigation structures.

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait DocumentNavigation
trait Navigatable
class Object
trait Matchable
class Any
Show all

Members list

Value members

Inherited methods

def asNavigationItem(context: NavigationBuilderContext): NavigationItem

Creates the navigation structure for this document up to the specified depth. The returned instance can be used as part of a bigger navigation structure comprising of trees, documents and their sections.

Creates the navigation structure for this document up to the specified depth. The returned instance can be used as part of a bigger navigation structure comprising of trees, documents and their sections.

Value parameters

context

captures the navigation depth, reference path and styles for the navigation tree being built

Attributes

Returns

a navigation item that can be used as part of a bigger navigation structure comprising of trees, documents and their sections

Inherited from:
DocumentNavigation
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product

Concrete fields

val targetFormats: TargetFormats

The formats this document should be rendered to.

The formats this document should be rendered to.

Attributes

Inherited fields

lazy val name: String

The local name of this navigatable.

The local name of this navigatable.

Attributes

Inherited from:
Navigatable
Generated with