examples-styler-ex

Use Styler on elixir code examples in your docs!

Usage

Examples Styler relies on adobe/elixir-styler, and acts as an extension to bring the same styling rules to your docs!

Add the following plugins value to your .formatter.exs file:

[
  plugins: [Styler.Examples.MultiPlugin],
  inputs: ...
]

There is no need to add Styler itself. By default, mix format will only run one plugin per file; Styler.MultiPlugin handles running both Styler and Styler.Examples on .exs and .ex files.

It will also run Styler.Examples.md and .cheatmd files.

Installation

If available in Hex, the package can be installed by adding vtc to your list of dependencies in mix.exs:

def deps do
  [
    {:examples_styler, "~> 0.1"}
  ]
end