Class: Coradoc::Markdown::ExampleBlock

Inherits:

Base

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

Defined in:

lib/coradoc/markdown/model/example_block.rb

Overview

Example block — an illustrative container, optionally with a caption.

Markdown has no native example syntax. Default rendering is an HTML fallback that preserves the caption as an ‘<h4>` heading inside a `<div class=“example”>` wrapper.

When ‘admonition_style == :container` (VitePress), the serializer emits `:::details Captionn…n:::`.

Instance Method Summary

• #initialize(content:, caption: nil, **rest) ⇒ ExampleBlock constructor

  A new instance of ExampleBlock.

Methods inherited from Base

visit, #visit

Constructor Details

#initialize(content:, caption: nil, **rest) ⇒ ExampleBlock

Returns a new instance of ExampleBlock.

# File 'lib/coradoc/markdown/model/example_block.rb', line 19

def initialize(content:, caption: nil, **rest)
  super
  @content = content
  @caption = caption
end