OpenrelikWorkerCommon.Reporting.MarkdownFormatter (openrelik_worker_common v0.1.0)

Copy Markdown View Source

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

Summary

Types

t()

Functions

blockquote(text)

Formats text as a blockquote of text in Markdown format.

blockquote(markdown_formatter, text)
bold(text)

Formats text as bold in Markdown format.

bold(markdown_formatter, text)
bullet(text, level \\ 1)

Formats text as a bullet in Markdown format.

bullet(markdown_formatter, text, level)
code(text)

Formats text as inline code in Markdown format.

code(markdown_formatter, text)
code_block(text)

Formats text as a code block in Markdown format.

code_block(markdown_formatter, text)
heading(text, level \\ 2)

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

heading(markdown_formatter, text, level)
horizontal_rule()

Formats a horizontal rule in Markdown format.

horizontal_rule(markdown_formatter)
new()
paragraph(text)

Formats text as a paragraph of text in Markdown format.

paragraph(markdown_formatter, text)
title(text)

Creates an H1 heading to use as page title.

title(markdown_formatter, text)

Types

t()

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

Functions

blockquote(text)

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

Formats text as a blockquote of text in Markdown format.

blockquote(markdown_formatter, text)

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

bold(text)

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

Formats text as bold in Markdown format.

bold(markdown_formatter, text)

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

bullet(text, level \\ 1)

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

Formats text as a bullet in Markdown format.

bullet(markdown_formatter, text, level)

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

code(text)

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

Formats text as inline code in Markdown format.

code(markdown_formatter, text)

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

code_block(text)

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

Formats text as a code block in Markdown format.

code_block(markdown_formatter, text)

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

heading(text, level \\ 2)

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

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

heading(markdown_formatter, text, level)

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

horizontal_rule()

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

Formats a horizontal rule in Markdown format.

horizontal_rule(markdown_formatter)

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

new()

@spec new() :: t()

paragraph(text)

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

Formats text as a paragraph of text in Markdown format.

paragraph(markdown_formatter, text)

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

title(text)

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

Creates an H1 heading to use as page title.

title(markdown_formatter, text)

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