Class: Coradoc::Markdown::DefinitionList

Inherits:

Base

• Object
• Lutaml::Model::Serializable
• Base
• Coradoc::Markdown::DefinitionList

Defined in:

lib/coradoc/markdown/model/definition_list.rb

Overview

DefinitionList model representing a Kramdown definition list.

Definition lists consist of terms followed by one or more definitions. The syntax uses ‘:` to start a definition.

Syntax:

term
: definition content

multiple terms
: first definition
: second definition

Examples:

Simple definition list

list = Coradoc::Markdown::DefinitionList.new(
  items: [
    Coradoc::Markdown::DefinitionTerm.new(
      text: "kramdown",
      definitions: [
        Coradoc::Markdown::DefinitionItem.new(content: "A Markdown parser")
      ]
    )
  ]
)

Method Summary

Methods inherited from Base

visit, #visit