# `OpenrelikWorkerCommon.Reporting.MarkdownFormatter`
[🔗](https://github.com/hacktobeer/openrelik-worker-common-elixir/blob/v0.1.0/lib/openrelik_worker_common/reporting.ex#L66)

Formats strings into Markdown elements (`openrelik_worker_common.reporting.MarkdownFormatter`).

# `t`

```elixir
@type t() :: %OpenrelikWorkerCommon.Reporting.MarkdownFormatter{}
```

# `blockquote`

```elixir
@spec blockquote(String.t()) :: String.t()
```

Formats text as a blockquote of text in Markdown format.

# `blockquote`

```elixir
@spec blockquote(t(), String.t()) :: String.t()
```

# `bold`

```elixir
@spec bold(String.t()) :: String.t()
```

Formats text as bold in Markdown format.

# `bold`

```elixir
@spec bold(t(), String.t()) :: String.t()
```

# `bullet`

```elixir
@spec bullet(String.t(), integer()) :: String.t()
```

Formats text as a bullet in Markdown format.

# `bullet`

```elixir
@spec bullet(t(), String.t(), integer()) :: String.t()
```

# `code`

```elixir
@spec code(String.t()) :: String.t()
```

Formats text as inline code in Markdown format.

# `code`

```elixir
@spec code(t(), String.t()) :: String.t()
```

# `code_block`

```elixir
@spec code_block(String.t()) :: String.t()
```

Formats text as a code block in Markdown format.

# `code_block`

```elixir
@spec code_block(t(), String.t()) :: String.t()
```

# `heading`

```elixir
@spec heading(String.t(), integer()) :: String.t()
```

Formats text as a heading in Markdown format (level 1..5).

# `heading`

```elixir
@spec heading(t(), String.t(), integer()) :: String.t()
```

# `horizontal_rule`

```elixir
@spec horizontal_rule() :: String.t()
```

Formats a horizontal rule in Markdown format.

# `horizontal_rule`

```elixir
@spec horizontal_rule(t()) :: String.t()
```

# `new`

```elixir
@spec new() :: t()
```

# `paragraph`

```elixir
@spec paragraph(String.t()) :: String.t()
```

Formats text as a paragraph of text in Markdown format.

# `paragraph`

```elixir
@spec paragraph(t(), String.t()) :: String.t()
```

# `title`

```elixir
@spec title(String.t()) :: String.t()
```

Creates an H1 heading to use as page title.

# `title`

```elixir
@spec title(t(), String.t()) :: String.t()
```

---

*Consult [api-reference.md](api-reference.md) for complete listing*