Packages

mdex

0.4.0
0.13.3 0.13.2 0.13.1 0.13.0 0.12.5 retired 0.12.4 0.12.3 0.12.2 0.12.1 0.12.0 0.11.7 0.11.6 0.11.5 0.11.4 0.11.3 0.11.2 0.11.1 0.11.0 0.10.0 0.9.4 0.9.3 0.9.2 0.9.1 0.9.0 0.8.6 0.8.5 0.8.4 0.8.3 0.8.2 0.8.1 0.8.0 0.7.5 0.7.4 0.7.3 0.7.2 0.7.1 0.7.0 0.6.2 0.6.1 0.6.0 0.5.0 0.4.3 0.4.2 0.4.1 0.4.0 0.3.3 0.3.2 0.3.1 0.3.0 0.2.0 0.1.18 0.1.17 0.1.16 0.1.15 0.1.14 0.1.13 0.1.12 0.1.11 0.1.10 0.1.9 0.1.8 0.1.7 0.1.6 0.1.5 0.1.4 0.1.3 0.1.2 0.1.1 0.1.0

Fast and extensible Markdown for Elixir

Security advisory: This version has known vulnerabilities. View advisories
HexDocs

Current section

Files

Jump to
Readme
69 Versions
2 Dependencies
36 Dependants
6 Advisories
Files
Activity
mdex mix.exs
Raw

mix.exs 

defmodule MDEx.MixProject do
  use Mix.Project
  @source_url "https://github.com/leandrocp/mdex"
  @version "0.4.0"
  @dev? String.ends_with?(@version, "-dev")
  @force_build? System.get_env("MDEX_BUILD") in ["1", "true"]
  def project do
    [
      app: :mdex,
      version: @version,
      elixir: "~> 1.13",
      start_permanent: Mix.env() == :prod,
      package: package(),
      docs: docs(),
      deps: deps(),
      aliases: aliases(),
      name: "MDEx",
      homepage_url: "https://github.com/leandrocp/mdex",
      description: "A CommonMark-compliant fast and extensible Markdown parser and formatter."
    ]
  end
  def application do
    [
      extra_applications: [:logger]
    ]
  end
  defp package do
    [
      maintainers: ["Leandro Pereira"],
      licenses: ["MIT"],
      links: %{
        Changelog: "https://hexdocs.pm/mdex/changelog.html",
        GitHub: @source_url,
        comrak: "https://crates.io/crates/comrak",
        DockYard: "https://dockyard.com"
      },
      files: ~w[
        lib/mdex.ex
        lib/mdex
        native/comrak_nif/src
        native/comrak_nif/vendor
        native/comrak_nif/.cargo
        native/comrak_nif/Cargo.*
        native/comrak_nif/Cross.toml
        examples
        mix.exs
        benchmark.exs
        README.md
        LICENSE.md
        CHANGELOG.md
        checksum-Elixir.MDEx.Native.exs
      ]
    ]
  end
  defp docs do
    [
      main: "MDEx",
      logo: "assets/images/mdex_icon.png",
      source_ref: "v#{@version}",
      source_url: @source_url,
      extras: ["CHANGELOG.md"],
      groups_for_modules: [
        "Document Nodes": [
          MDEx.FrontMatter,
          MDEx.BlockQuote,
          MDEx.List,
          MDEx.ListItem,
          MDEx.DescriptionList,
          MDEx.DescriptionItem,
          MDEx.DescriptionTerm,
          MDEx.DescriptionDetails,
          MDEx.CodeBlock,
          MDEx.HtmlBlock,
          MDEx.Paragraph,
          MDEx.Heading,
          MDEx.ThematicBreak,
          MDEx.FootnoteDefinition,
          MDEx.FootnoteReference,
          MDEx.Table,
          MDEx.TableRow,
          MDEx.TableCell,
          MDEx.Text,
          MDEx.TaskItem,
          MDEx.SoftBreak,
          MDEx.LineBreak,
          MDEx.Code,
          MDEx.HtmlInline,
          MDEx.Raw,
          MDEx.Emph,
          MDEx.Strong,
          MDEx.Strikethrough,
          MDEx.Superscript,
          MDEx.Link,
          MDEx.Image,
          MDEx.ShortCode,
          MDEx.Math,
          MDEx.MultilineBlockQuote,
          MDEx.Escaped,
          MDEx.WikiLink,
          MDEx.Underline,
          MDEx.Subscript,
          MDEx.SpoileredText,
          MDEx.EscapedTag
        ]
      ],
      skip_undefined_reference_warnings_on: ["CHANGELOG.md"],
      before_closing_head_tag: fn type ->
        if type == :html do
          """
          <script>
            if (location.hostname === "hexdocs.pm") {
              var script = document.createElement("script");
              script.src = "https://plausible.io/js/script.js";
              script.setAttribute("defer", "defer")
              script.setAttribute("data-domain", "mdexhexdocs")
              document.head.appendChild(script);
            }
          </script>
          """
        end
      end
    ]
  end
  defp deps do
    [
      {:rustler, "~> 0.32", optional: not (@dev? or @force_build?)},
      {:rustler_precompiled, "~> 0.7"},
      {:ex_doc, "~> 0.34", only: :dev}
    ]
  end
  defp aliases do
    [
      "deps.vendorize": ["cmd cp -rv ../autumn/native/autumn native/comrak_nif/vendor"],
      "gen.checksum": "rustler_precompiled.download MDEx.Native --all --print",
      "gen.samples": "mdex.generate_samples",
      "format.all": ["format", "rust.fmt"],
      "rust.lint": ["cmd cargo clippy --manifest-path=native/comrak_nif/Cargo.toml -- -Dwarnings"],
      "rust.fmt": ["cmd cargo fmt --manifest-path=native/comrak_nif/Cargo.toml --all"]
    ]
  end
end