Class: Anydoc::Block

Inherits:

Data

• Object
• Data
• Anydoc::Block

Defined in:

lib/anydoc/document.rb,
sig/anydoc.rbs

Overview

One block-level piece of content.

Instance Attribute Summary

• #anchor ⇒ String^? readonly

  Heading: stable anchor id, when the document targets this heading.

• #blocks ⇒ Array<Block>^? readonly

  Block_quote.

• #content ⇒ Array<Inline>^? readonly

  Heading, paragraph.

• #kind ⇒ Symbol readonly

  :heading | :paragraph | :list | :table | :block_quote | :code_block | :rule.

• #lang ⇒ String^? readonly

  Code_block.

• #level ⇒ Integer^? readonly

  Heading: 1-6.

• #list ⇒ List^? readonly
• #table ⇒ Table^? readonly
• #text ⇒ String^? readonly

  Code_block.

Instance Attribute Details

#anchor ⇒ String^? (readonly)

Returns heading: stable anchor id, when the document targets this heading.

Returns:

• (String, nil) —

  heading: stable anchor id, when the document targets this heading.

# File 'lib/anydoc/document.rb', line 53

class Block < Data.define(
  :kind, :level, :anchor, :content, :list, :table, :blocks, :lang, :text
)
end

#blocks ⇒ Array<Block>^? (readonly)

Returns block_quote.

Returns:

• (Array<Block>, nil) —

  block_quote.

# File 'lib/anydoc/document.rb', line 53

class Block < Data.define(
  :kind, :level, :anchor, :content, :list, :table, :blocks, :lang, :text
)
end

#content ⇒ Array<Inline>^? (readonly)

Returns heading, paragraph.

Returns:

• (Array<Inline>, nil) —

  heading, paragraph.

# File 'lib/anydoc/document.rb', line 53

class Block < Data.define(
  :kind, :level, :anchor, :content, :list, :table, :blocks, :lang, :text
)
end

#kind ⇒ Symbol (readonly)

:heading | :paragraph | :list | :table | :block_quote | :code_block | :rule

Returns:

• (Symbol)

# File 'lib/anydoc/document.rb', line 53

class Block < Data.define(
  :kind, :level, :anchor, :content, :list, :table, :blocks, :lang, :text
)
end

#lang ⇒ String^? (readonly)

Returns code_block.

Returns:

• (String, nil) —

  code_block.

# File 'lib/anydoc/document.rb', line 53

class Block < Data.define(
  :kind, :level, :anchor, :content, :list, :table, :blocks, :lang, :text
)
end

#level ⇒ Integer^? (readonly)

Returns heading: 1-6.

Returns:

• (Integer, nil) —

  heading: 1-6.

# File 'lib/anydoc/document.rb', line 53

class Block < Data.define(
  :kind, :level, :anchor, :content, :list, :table, :blocks, :lang, :text
)
end

#list ⇒ List^? (readonly)

Returns:

• (List, nil)

# File 'lib/anydoc/document.rb', line 53

class Block < Data.define(
  :kind, :level, :anchor, :content, :list, :table, :blocks, :lang, :text
)
end

#table ⇒ Table^? (readonly)

Returns:

• (Table, nil)

# File 'lib/anydoc/document.rb', line 53

class Block < Data.define(
  :kind, :level, :anchor, :content, :list, :table, :blocks, :lang, :text
)
end

#text ⇒ String^? (readonly)

Returns code_block.

Returns:

• (String, nil) —

  code_block.

# File 'lib/anydoc/document.rb', line 53

class Block < Data.define(
  :kind, :level, :anchor, :content, :list, :table, :blocks, :lang, :text
)
end