laika-core
API
Generated with
laika-core/laika/laika.directive

laika.directive

package laika.directive

Members list

Packages

package laika.directive.std

Type members

Classlikes

sealed abstract class AttributeKey

The id for a directive part.

The id for a directive part.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Named
object Positional.type
class PositionalAt
object AttributeKey

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
object Blocks extends BuilderContext[Block]

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

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

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Blocks.type
trait BuilderContext[E <: Element]

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.

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.

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Blocks.type
object Spans.type
object Templates.type
trait DirectiveRegistry extends ExtensionBundle

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:

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

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object StandardDirectives.type
Self type
class DirectiveSupport(blockDirectives: Seq[Directive], spanDirectives: Seq[Directive], templateDirectives: Seq[Directive], linkDirectives: Seq[Directive], strictMode: Boolean) extends ExtensionBundle

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.

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.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object DirectiveSupport.type
Self type
object DirectiveSupport extends DirectiveSupport

Empty default instance without any directives installed.

Empty default instance without any directives installed.

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
object Links

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

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

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Links.type
object Spans extends BuilderContext[Span]

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

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

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Spans.type
object Templates extends BuilderContext[TemplateSpan]

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

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

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Templates.type
Generated with