@type formatter() :: formatter_name() | formatter_with_options()

Highlighter formatter and its options.

Available formatters: :html_inline, :html_linked, :terminal

• :html_inline - generates <span> tags with inline styles for each token, for example: <span style="color: #6eb4bff;">Atom</span>.
• :html_linked - generates <span> tags with class representing the token type, for example: <span class="keyword-special">Atom</span>. Must link an external CSS in order to render colors, see an example in the Formatters section.
• :terminal - generates ANSI escape codes for terminal output.

You can either pass the formatter as an atom to use default options or a tuple with the formatter name and options, so both are equivalent:

# passing only the formatter name like below:
:terminal
# is the same as passing an empty list of options:
{:terminal, []}

Options available

• html_inline:

  • :pre_class (String.t/0 - default: nil) - the CSS class to append into the wrapping <pre> tag.
  • :italic (boolean/0 - default: false) - enable italic style for the highlighted code.
  • :include_highlights (boolean/0 - default: false) - include the highlight scope name in a data-highlight attribute. Useful for debugging.

• html_linked:

  • :pre_class (String.t/0 - default: nil) - the CSS class to append into the wrapping <pre> tag.

• terminal:

  • :italic (boolean/0 - default: false) - enable italic style for the highlighted code.

Examples

{:html_inline, pre_class: "example-01", include_highlights: true}

{:html_linked, pre_class: "example-01"}

{:terminal, []}

{:terminal, italic: true}

See https://docs.rs/autumnus/latest/autumnus/enum.FormatterOption.html for more info.

@type lang_or_file() :: String.t() | nil

A language name, filename, or path with extesion.

Examples

- "elixir"
- ".ex"
- "app.ex"
- "lib/app.ex"