Defines all supported standard text roles of the reStructuredText reference parser.
The following text roles are fully supported:
emphasis
strong
literal
subscript (and sub alias)
superscript (and sup alias)
title-reference (and title alias) - the default role
raw (+ format option) (needs to be enabled explicitly through ReStructuredText.withRawElements)
The following text role is supported with some limitation:
code does currently not support syntax highlighting
(it allows to set the language so client-side highlighters can be integrated if required)
The following text roles are not supported:
math
pep-reference
rfc-reference
In contrast to the reference parser the default-role directive cannot be supported
in Laika as the parser is not stateful. Therefore it is not possible to change the
default role half-way through a parsing process. However the default role can be specified
through the API when creating a parser instance:
object RstExtensions extends RstExtensionRegistry {
val blockDirectives = Nil
val spanDirectives = Nil
val textRoles = Nil
override val defaultTextRole = "my-role-name"
}
val transformer = Transformer.from(ReStructuredText).to(HTML).using(RstExtensions)