Packages

earmark

1.4.10
1.5.0-pre1 retired 1.5.0-pre retired 1.4.49 retired 1.4.48 retired 1.4.47 retired 1.4.46 retired 1.4.45 retired 1.4.44 retired 1.4.43 retired 1.4.42 retired 1.4.41 retired 1.4.40 retired 1.4.39 retired 1.4.38 retired 1.4.37 retired 1.4.36 retired 1.4.35 retired 1.4.34 retired 1.4.33 retired 1.4.32 retired 1.4.31 retired 1.4.30 retired 1.4.29 retired 1.4.28 retired 1.4.27 retired 1.4.26 retired 1.4.25 retired 1.4.24 retired 1.4.23 retired 1.4.22 retired 1.4.21 retired 1.4.20 retired 1.4.19 retired 1.4.18 retired 1.4.17 retired 1.4.16 retired 1.4.16-pre2 retired 1.4.16-pre1 retired 1.4.16-pre retired 1.4.15 retired 1.4.14 retired 1.4.13 retired 1.4.12 retired 1.4.10 retired 1.4.9 retired 1.4.8 retired 1.4.7 retired 1.4.6 retired 1.4.5 retired 1.4.4 retired 1.4.3 retired 1.4.2 retired 1.4.1 retired 1.4.0 retired 1.3.6 retired 1.3.5 retired 1.3.4 retired 1.3.3 retired 1.3.2 retired 1.3.1 retired 1.3.0 retired 1.2.6 retired 1.2.5 retired 1.2.4 retired 1.2.3 retired 1.2.2 retired 1.2.1 retired 1.2.0 retired 1.1.1 retired 1.1.0 retired 1.0.3 retired 1.0.2 retired 1.0.1 retired 1.0.0 retired 0.2.1 retired 0.2.0 retired 0.1.19 retired 0.1.18 retired 0.1.17 retired 0.1.16 retired 0.1.15 retired 0.1.14 retired 0.1.13 retired 0.1.12 retired 0.1.10 retired 0.1.9 retired 0.1.8 retired 0.1.7 retired 0.1.6 retired 0.1.5 retired 0.1.4 retired 0.1.3 retired 0.1.2 retired 0.1.1 retired 0.1.0 retired

Earmark is a pure-Elixir Markdown converter. It is intended to be used as a library (just call Earmark.as_html), but can also be used as a command-line tool (run mix escript.build first). Output generation is pluggable.

Retired package: Deprecated - Earmark is no longer maintained. Migrate to a replacement, for example MDEx (https://hex.pm/packages/mdex).
Security advisory: This version has known vulnerabilities. View advisories
HexDocs

Current section

Files

Jump to
Readme
95 Versions
1 Dependency
114 Dependants
1 Advisory
Files
Activity
earmark mix.exs
Raw

mix.exs 

defmodule Earmark.Mixfile do

  use Mix.Project



  @version "1.4.10"



  @url "https://github.com/pragdave/earmark"





  @deps [

    {:earmark_parser, ">= 1.4.10"},

    {:dialyxir, "~> 1.0", only: [:dev, :test], runtime: false},

    {:benchfella, "~> 0.3.0", only: [:dev]},

    {:earmark_ast_dsl, "~> 0.2.5", only: [:test]},

    {:excoveralls, "~> 0.11.2", only: [:test]},

    {:floki, "~> 0.21", only: [:dev, :test]},

    {:traverse, "~> 1.0.0", only: [:dev, :test]}

  ]



  @description """

  Earmark is a pure-Elixir Markdown converter.



  It is intended to be used as a library (just call Earmark.as_html),

  but can also be used as a command-line tool (run mix escript.build

  first).



  Output generation is pluggable.

  """



  ############################################################



  def project do

    [

      app: :earmark,

      version: @version,

      elixir: "~> 1.7",

      elixirc_paths: elixirc_paths(Mix.env()),

      escript: escript_config(),

      deps: @deps,

      description: @description,

      package: package(),

      preferred_cli_env: [

        coveralls: :test,

        "coveralls.detail": :test,

        "coveralls.post": :test,

        "coveralls.html": :test

      ],

      test_coverage: [tool: ExCoveralls],

      aliases: [docs: &build_docs/1, readme: &readme/1]

    ]

  end



  defp package do

    [

      files: [

        "lib",

        "mix.exs",

        "README.md"

      ],

      maintainers: [

        "Robert Dober <robert.dober@gmail.com>",

        "Dave Thomas <dave@pragdave.me>"

      ],

      licenses: [

        "Apache-2.0"

      ],

      links: %{

        "GitHub" => "https://github.com/pragdave/earmark"

      }

    ]

  end



  defp escript_config do

    [main_module: Earmark.CLI]

  end



  defp elixirc_paths(:test), do: ["lib", "test/support", "dev"]

  defp elixirc_paths(:dev), do: ["lib", "bench", "dev"]

  defp elixirc_paths(_), do: ["lib"]



  @prerequisites """

  run `mix escript.install hex ex_doc` and adjust `PATH` accordingly

  """

  defp build_docs(_) do

    Mix.Task.run("compile")

    ex_doc = Path.join(Mix.path_for(:escripts), "ex_doc")

    Mix.shell().info("Using escript: #{ex_doc} to build the docs")



    unless File.exists?(ex_doc) do

      raise "cannot build docs because escript for ex_doc is not installed, make sure to \n#{@prerequisites}"

    end



    args = ["Earmark", @version, Mix.Project.compile_path()]

    opts = ~w[--main Earmark --source-ref v#{@version} --source-url #{@url}]



    Mix.shell().info("Running: #{ex_doc} #{inspect(args ++ opts)}")

    System.cmd(ex_doc, args ++ opts)

    Mix.shell().info("Docs built successfully")

  end



  defp readme(args) do

    Code.require_file("tasks/readme.exs")

    Mix.Tasks.Readme.run(args)

  end

end



# SPDX-License-Identifier: Apache-2.0