defmodule PhoenixMarkdown do

  @moduledoc """
  ## Usage

    1. Add `{:phoenix_markdown, "~> 0.1"}` to your deps in `mix.exs`.
    2. Add the following to your Phoenix `config/config.exs`

       ```elixir
      config :phoenix, :template_engines,
        md: PhoenixMarkdown.Engine
       ```

      If you are also using the [phoenix_haml](https://github.com/chrismccord/phoenix_haml) engine,
      then it should look like this:
       ```elixir
      config :phoenix, :template_engines,
        haml: PhoenixHaml.Engine,
        md:   PhoenixMarkdown.Engine
       ```


    3. Use the `.html.md` extensions for your templates.

  ## Optional

  Add md extension to Phoenix live reload in `config/dev.exs`

  ```elixir
    config :hello_phoenix, HelloPhoenix.Endpoint,
      live_reload: [
        patterns: [
          ~r{priv/static/.*(js|css|png|jpeg|jpg|gif|svg)$},
          ~r{web/views/.*(ex)$},
          ~r{web/templates/.*(eex|md)$}
        ]
      ]
  ```

  If you are also using the [phoenix_haml](https://github.com/chrismccord/phoenix_haml) engine,
  then the pattern should look like this:

  ```elixir
    config :hello_phoenix, HelloPhoenix.Endpoint,
      live_reload: [
        patterns: [
          ~r{priv/static/.*(js|css|png|jpeg|jpg|gif|svg)$},
          ~r{web/views/.*(ex)$},
          ~r{web/templates/.*(eex|haml|md)$}
        ]
      ]
  ```

  ## Generators / Use

  There are no generators for phoenix_markdown since they wouldn't make sense. If you want to include
  markdown in a page with dynamic contact, use render and target the markdown template.

  Like this:
  ```elixir
    <% render("some_markdown.md") %>
  ```

  [Markdown](https://daringfireball.net/projects/markdown/) is intended to be written by a human
  in any simple text editor ( or a fancy one like [iA Writer](https://ia.net/writer) ). Just create
  a file with the `.html.md` extension and drop it into the appropriate templates folder in your
  phoenix application. Then you can use it just like any other template.
  """



end