View Source Kino.Markdown (Kino v0.13.2)

A kino for rendering Markdown content.

This is just a meta-struct that implements the Kino.Render protocol, so that it gets rendered as markdown.

Examples 

Kino.Markdown.new("""
# Example

A regular Markdown file.

## Code

```elixir
"Elixir" |> String.graphemes() |> Enum.frequencies()
```

## Table

| ID | Name   | Website                 |
| -- | ------ | ----------------------- |
| 1  | Elixir | https://elixir-lang.org |
| 2  | Erlang | https://www.erlang.org  |
""")

This format may come in handy when exploring Markdown from external sources:

text = File.read!("/path/to/README.md")
Kino.Markdown.new(text)

Summary

Types

t()

Functions

new(text, opts \\ [])

Creates a new kino displaying the given Markdown content.

Types

Link to this opaque

t()

View Source 
@opaque t()

Functions

Link to this function

new(text, opts \\ [])

View Source 
@spec new(
  binary(),
  keyword()
) :: t()

Creates a new kino displaying the given Markdown content.

Options

  • :chunk - whether this is a part of a larger text. Adjacent chunks are merged into a single text. This is useful for streaming content. Defaults to false

Examples

Using the :chunk option

Using a Kino.Frame.

frame = Kino.Frame.new() |> Kino.render()

for word <- ["who", " *let*", " `the`", " **dogs**", " out"] do
  text = Kino.Markdown.new(word, chunk: true)
  Kino.Frame.append(frame, text)
  Process.sleep(250)
end

Without using a Kino.Frame.

for word <- ["who", " *let*", " `the`", " **dogs**", " out"] do
  Kino.Markdown.new(word, chunk: true) |> Kino.render()
  Process.sleep(250)
end

Kino.nothing()