ToMarkdown

zio.blocks.docs.ToMarkdown
See theToMarkdown companion object
trait ToMarkdown[-A]

Type class for converting values to markdown inline elements.

Used by the md string interpolator to support interpolation of arbitrary types. Implement this trait for custom types to enable markdown interpolation.

Type parameters

A

The type to convert to markdown

Attributes

Example
 case class Person(name: String, age: Int)
implicit val personToMarkdown: ToMarkdown[Person] = (p: Person) =>
Strong(Chunk(Text(p.name)))
val person = Person("Alice", 30) val doc = md"# User: $$person" 
Companion
object
Source
ToMarkdown.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Abstract methods

def toMarkdown(a: A): Inline
Implicitly added by chunkToMarkdown

Convert a value to a markdown inline element.

Convert a value to a markdown inline element.

Value parameters

a

The value to convert

Attributes

Returns

An inline markdown element

Source
ToMarkdown.scala
def toMarkdown(a: A): Inline
Implicitly added by listToMarkdown

Convert a value to a markdown inline element.

Convert a value to a markdown inline element.

Value parameters

a

The value to convert

Attributes

Returns

An inline markdown element

Source
ToMarkdown.scala
def toMarkdown(a: A): Inline
Implicitly added by seqToMarkdown

Convert a value to a markdown inline element.

Convert a value to a markdown inline element.

Value parameters

a

The value to convert

Attributes

Returns

An inline markdown element

Source
ToMarkdown.scala
def toMarkdown(a: A): Inline
Implicitly added by vectorToMarkdown

Convert a value to a markdown inline element.

Convert a value to a markdown inline element.

Value parameters

a

The value to convert

Attributes

Returns

An inline markdown element

Source
ToMarkdown.scala
def toMarkdown(a: A): Inline

Convert a value to a markdown inline element.

Convert a value to a markdown inline element.

Value parameters

a

The value to convert

Attributes

Returns

An inline markdown element

Source
ToMarkdown.scala