Packages

p

laika

directive

package directive

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. All

Type Members

  1. sealed abstract class AttributeKey extends AnyRef

    The id for a directive part.

  2. trait BuilderContext[E <: Element] extends AnyRef

    Provides the basic building blocks for Laika's Directive API.

    Provides the basic building blocks for Laika's Directive API. This trait is not used directly, but instead its three sub-traits Blocks, Spans and Templates, which represent the concrete implementations for the three directive types.

  3. trait DirectiveRegistry extends ExtensionBundle

    Registry for custom directives.

    Registry for custom directives. Application code can define any number of instances mixing in this trait and then pass them to Parse, Render or Transform operations:

    object MyDirectives extends DirectiveRegistry {
  val spanDirectives = Seq(...)
  val blockDirectives = Seq(...)
  val templateDirectives = Seq(...)
  val linkDirectives = Seq(...)
}
object OtherDirectives extends DirectiveRegistry {
  [...]
}

val transformer = Transformer
  .from(Markdown)
  .to(HTML)
  .using(MyDirectives, OtherDirectives)
  .build
  4. class DirectiveSupport extends ExtensionBundle

    Internal API that processes all directives defined by one or more DirectiveRegistries.

    Internal API that processes all directives defined by one or more DirectiveRegistries. This extension is installed by default, unless the transformation is run in strict mode.

Value Members

  1. object AttributeKey
  2. object Blocks extends BuilderContext[Block]

    The API for declaring directives that can be used as block elements in markup documents.

  3. object DirectiveSupport extends DirectiveSupport

    Empty default instance without any directives installed.

  4. object Links

    The API for declaring directives that can be used in links.

  5. object Spans extends BuilderContext[Span]

    The API for declaring directives that can be used as inline elements in markup documents.

  6. object Templates extends BuilderContext[TemplateSpan]

    The API for declaring directives that can be used in templates.

Ungrouped