Docs: Include more files, add ex_doc as a direct dependency

RELEASE.md

@@ -400,47 +400,47 @@ underlines for readability.
 
 # 1.4.0 2019/09/05
 
-- [145 Expose AST for output manipulation]( https://github.com/pragdave/earmark/issues/145)
+- [145 Expose AST for output manipulation](https://github.com/pragdave/earmark/issues/145)
 
-- [238 Pure Links are default now]( https://github.com/pragdave/earmark/issues/238)
+- [238 Pure Links are default now](https://github.com/pragdave/earmark/issues/238)
 
-- [256 Align needed Elixir Version with ex_doc (>= 1.7)]( https://github.com/pragdave/earmark/issues/256)
+- [256 Align needed Elixir Version with ex_doc (>= 1.7)](https://github.com/pragdave/earmark/issues/256)
 
-- [259 Deprecated option `sanitize` removed]( https://github.com/pragdave/earmark/issues/259)
+- [259 Deprecated option `sanitize` removed](https://github.com/pragdave/earmark/issues/259)
 
-- [261 Deprecated Plugins removed]( https://github.com/pragdave/earmark/issues/261)
+- [261 Deprecated Plugins removed](https://github.com/pragdave/earmark/issues/261)
 
-- [265 Make deprecated `Earmark.parse/2` private]( https://github.com/pragdave/earmark/issues/265)
+- [265 Make deprecated `Earmark.parse/2` private](https://github.com/pragdave/earmark/issues/265)
 
 
 # 1.3.6 2019/08/30
 
 Hopefully the last patch release of 1.3 before the structural changes of 1.4.
 
--  [#270]( https://github.com/pragdave/earmark/issues/270)
+-  [#270](https://github.com/pragdave/earmark/issues/270)
       Error messages during parsing of table celles were duplicated in a number, exponential to the number of table cells.
 
--  [#268]( https://github.com/pragdave/earmark/issues/268)
+-  [#268](https://github.com/pragdave/earmark/issues/268)
       Deprecation warnings concerning pure links showed fixed link to https://github.com/pragdave/earmark, at least a reasonable choice ;),
       instead of the text of the link.
 
--  [#266]( https://github.com/pragdave/earmark/issues/266)
+-  [#266](https://github.com/pragdave/earmark/issues/266)
     According to HTML5 Style Guide better XHTML compatibility by closing void tags e.g. `<hr>` --&gt; `<hr />`
 
 
 # 1.3.5 2019/08/01
 
--  [#264]( https://github.com/pragdave/earmark/issues/264)
+-  [#264](https://github.com/pragdave/earmark/issues/264)
       Expose `Earmark.parse/2` but deprecate it.
 
--  [#262]( https://github.com/pragdave/earmark/issues/262)
+-  [#262](https://github.com/pragdave/earmark/issues/262)
     Remove non XHTML tags <colgroup> and <col>
 
 
--  [#236]( https://github.com/pragdave/earmark/issues/236)
+-  [#236](https://github.com/pragdave/earmark/issues/236)
       Deprecation of plugins.
 
--  [#257]( https://github.com/pragdave/earmark/issues/257)
+-  [#257](https://github.com/pragdave/earmark/issues/257)
       Deprecation of `sanitize` option.
 
 # 1.3.4 2019/07/29
@@ -493,25 +493,25 @@ Hopefully the last patch release of 1.3 before the structural changes of 1.4.
 
 * Fix for issues
 
-  - [#224 titles might be extracted from outside link]( https://github.com/pragdave/earmark/issues/224 )
-  - [#220 render only first link title always correctly]( https://github.com/pragdave/earmark/issues/220 )
-  - [#218 replaced iff with longer but clearer if and only if ]( https://github.com/pragdave/earmark/issues/218 )
+  - [#224 titles might be extracted from outside link](https://github.com/pragdave/earmark/issues/224)
+  - [#220 render only first link title always correctly](https://github.com/pragdave/earmark/issues/220)
+  - [#218 replaced iff with longer but clearer if and only if ](https://github.com/pragdave/earmark/issues/218)
 
 ## Kudos:
   [niku](https://github.com/niku) for #218
   [Rich Morin](https://github.com/RichMorin) for #220 &amp; #224 as well as discussions
 
 # 1.3.1 2018/12/21
 
-  - [#212 spaces at line end force line break]( https://github.com/pragdave/earmark/issues/212 )
-  - [#211 documentation explaining error messages]( https://github.com/pragdave/earmark/issues/211 )
+  - [#212 spaces at line end force line break](https://github.com/pragdave/earmark/issues/212)
+  - [#211 documentation explaining error messages](https://github.com/pragdave/earmark/issues/211)
 
 # 1.3.0 2018/11/15
 
 * Fix for issues
-  - [#208 Inline code made Commonmark compatible]( https://github.com/pragdave/earmark/issues/208 )
-  - [#203 escript does not report filename in error messages]( https://github.com/pragdave/earmark/issues/203 )
-  - [#90 Parsing "...' or '..." as link titles removed]( https://github.com/pragdave/earmark/issues/90 )
+  - [#208 Inline code made Commonmark compatible](https://github.com/pragdave/earmark/issues/208)
+  - [#203 escript does not report filename in error messages](https://github.com/pragdave/earmark/issues/203)
+  - [#90 Parsing "...' or '..." as link titles removed](https://github.com/pragdave/earmark/issues/90)
 
 ## Dev dependencies updated
 
@@ -527,21 +527,21 @@ Hopefully the last patch release of 1.3 before the structural changes of 1.4.
 # 1.2.6 2018/08/21
 
 * Fix for issues
-  - [#198 Escapes inside link texts are ignored]( https://github.com/pragdave/earmark/issues/198 )
-  - [#197 README task broken in Elixir 1.7]( https://github.com/pragdave/earmark/issues/197 )
-  - [#191 Allow configurable timeout for parallel map]( https://github.com/pragdave/earmark/issues/191 )
-  - [#190 do not include generated src/*.erl in the package]( https://github.com/pragdave/earmark/issues/190 )
+  - [#198 Escapes inside link texts are ignored](https://github.com/pragdave/earmark/issues/198)
+  - [#197 README task broken in Elixir 1.7](https://github.com/pragdave/earmark/issues/197)
+  - [#191 Allow configurable timeout for parallel map](https://github.com/pragdave/earmark/issues/191)
+  - [#190 do not include generated src/*.erl in the package](https://github.com/pragdave/earmark/issues/190)
 
-* [#195 incorrect HTML for inline code blocks and IAL specified classes](https://github.com/pragdave/earmark/issues/195) from [Benjamin Milde]( https://github.com/LostKobrakai )
+* [#195 incorrect HTML for inline code blocks and IAL specified classes](https://github.com/pragdave/earmark/issues/195) from [Benjamin Milde](https://github.com/LostKobrakai)
 
 # 1.2.5 2018/04/02
 
 * Fix for issues
-  - [#161]( https://github.com/pragdave/earmark/issues/161 )
-  - [#168]( https://github.com/pragdave/earmark/issues/168 )
-  - [#172]( https://github.com/pragdave/earmark/issues/172 )
-  - [#175]( https://github.com/pragdave/earmark/issues/175 )
-  - [#181]( https://github.com/pragdave/earmark/issues/181 )
+  - [#161](https://github.com/pragdave/earmark/issues/161)
+  - [#168](https://github.com/pragdave/earmark/issues/168)
+  - [#172](https://github.com/pragdave/earmark/issues/172)
+  - [#175](https://github.com/pragdave/earmark/issues/175)
+  - [#181](https://github.com/pragdave/earmark/issues/181)
 
 * [#178](https://github.com/pragdave/earmark/pull/178) from [jwworth](https://github.com/jwworth)
 
@@ -551,7 +551,7 @@ Hopefully the last patch release of 1.3 before the structural changes of 1.4.
 # 1.2.4 2017/11/28
 
 * Fix for issue
-  - [#166]( https://github.com/pragdave/earmark/issues/166 )
+  - [#166](https://github.com/pragdave/earmark/issues/166)
 
 * [PR160](https://github.com/pragdave/earmark/pull/160) from [simonwebdesign](https://github.com/simonewebdesign)
 * [PR163](https://github.com/pragdave/earmark/pull/163) from [nscyclone](https://github.com/nscyclone)

mix.exs

@@ -10,6 +10,7 @@ defmodule Earmark.Mixfile do
     {:benchfella, "~> 0.3.0", only: [:dev]},
     {:earmark_ast_dsl, "~> 0.3.6", only: [:dev, :test]},
     {:excoveralls, "~> 0.16.0", only: [:test]},
+    {:ex_doc, "~> 0.38.2", only: [:dev]},
     # {:extractly, "~> 0.5.0", git: "https://github.com/RobertDober/extractly.git", tag: "v0.5.0-pre1", only: [:dev]},
     {:extractly, "~> 0.5.3", only: [:dev]},
     {:floki, "~> 0.21", only: [:dev, :test]},
@@ -46,7 +47,7 @@ defmodule Earmark.Mixfile do
         "coveralls.html": :test
       ],
       test_coverage: [tool: ExCoveralls],
-      aliases: [docs: &build_docs/1]
+      docs: docs()
     ]
   end
 
@@ -87,24 +88,13 @@ defmodule Earmark.Mixfile do
     ]
   end
 
-  @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")
+  defp docs() do
+    [
+      main: "readme",
+      source_ref: "v#{@version}",
+      source_url: @url,
+      extras: ["README.md", "RELEASE.md", "LICENSE"]
+    ]
   end
 end
 

mix.lock

@@ -3,17 +3,22 @@
   "certifi": {:hex, :certifi, "2.9.0", "6f2a475689dd47f19fb74334859d460a2dc4e3252a3324bd2111b8f0429e7e21", [:rebar3], [], "hexpm", "266da46bdb06d6c6d35fde799bcb28d36d985d424ad7c08b5bb48f5b5cdd4641"},
   "dialyxir": {:hex, :dialyxir, "1.1.0", "c5aab0d6e71e5522e77beff7ba9e08f8e02bad90dfbeffae60eaf0cb47e29488", [:mix], [{:erlex, ">= 0.2.6", [hex: :erlex, repo: "hexpm", optional: false]}], "hexpm", "07ea8e49c45f15264ebe6d5b93799d4dd56a44036cf42d0ad9c960bc266c0b9a"},
   "earmark_ast_dsl": {:hex, :earmark_ast_dsl, "0.3.6", "bc3b0f06bdf89532cd039ea5b4e0df3839395a8197e46a7d7daa0bbd801202a9", [:mix], [], "hexpm", "47cc790831d41843d793fe0b6462036f2c615bb6a7b3874282431928c3824d07"},
-  "earmark_parser": {:hex, :earmark_parser, "1.4.35", "437773ca9384edf69830e26e9e7b2e0d22d2596c4a6b17094a3b29f01ea65bb8", [:mix], [], "hexpm", "8652ba3cb85608d0d7aa2d21b45c6fad4ddc9a1f9a1f1b30ca3a246f0acc33f6"},
+  "earmark_parser": {:hex, :earmark_parser, "1.4.44", "f20830dd6b5c77afe2b063777ddbbff09f9759396500cdbe7523efd58d7a339c", [:mix], [], "hexpm", "4778ac752b4701a5599215f7030989c989ffdc4f6df457c5f36938cc2d2a2750"},
   "erlex": {:hex, :erlex, "0.2.6", "c7987d15e899c7a2f34f5420d2a2ea0d659682c06ac607572df55a43753aa12e", [:mix], [], "hexpm", "2ed2e25711feb44d52b17d2780eabf998452f6efda104877a3881c2f8c0c0c75"},
+  "ex_doc": {:hex, :ex_doc, "0.38.2", "504d25eef296b4dec3b8e33e810bc8b5344d565998cd83914ffe1b8503737c02", [:mix], [{:earmark_parser, "~> 1.4.44", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_c, ">= 0.1.0", [hex: :makeup_c, repo: "hexpm", optional: true]}, {:makeup_elixir, "~> 0.14 or ~> 1.0", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1 or ~> 1.0", [hex: :makeup_erlang, repo: "hexpm", optional: false]}, {:makeup_html, ">= 0.1.0", [hex: :makeup_html, repo: "hexpm", optional: true]}], "hexpm", "732f2d972e42c116a70802f9898c51b54916e542cc50968ac6980512ec90f42b"},
   "excoveralls": {:hex, :excoveralls, "0.16.0", "41f4cfbf7caaa3bc2cf411db6f89c1f53afedf0f1fe8debac918be1afa19c668", [:mix], [{:hackney, "~> 1.16", [hex: :hackney, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "401205356482ab99fb44d9812cd14dd83b65de8e7ae454697f8b34ba02ecd916"},
   "extractly": {:hex, :extractly, "0.5.3", "ca6afc3430e63cc9017d50eb03bdf1a3499c7e888037d2279b0ec0ea393af390", [:mix], [], "hexpm", "858f7a285ffb767937e75bb8866f03fecb3b7e5b42728a9677d2ebb6ea885503"},
   "floki": {:hex, :floki, "0.32.0", "f915dc15258bc997d49be1f5ef7d3992f8834d6f5695270acad17b41f5bcc8e2", [:mix], [{:html_entities, "~> 0.5.0", [hex: :html_entities, repo: "hexpm", optional: false]}], "hexpm", "1c5a91cae1fd8931c26a4826b5e2372c284813904c8bacb468b5de39c7ececbd"},
   "hackney": {:hex, :hackney, "1.18.1", "f48bf88f521f2a229fc7bae88cf4f85adc9cd9bcf23b5dc8eb6a1788c662c4f6", [:rebar3], [{:certifi, "~>2.9.0", [hex: :certifi, repo: "hexpm", optional: false]}, {:idna, "~>6.1.0", [hex: :idna, repo: "hexpm", optional: false]}, {:metrics, "~>1.0.0", [hex: :metrics, repo: "hexpm", optional: false]}, {:mimerl, "~>1.1", [hex: :mimerl, repo: "hexpm", optional: false]}, {:parse_trans, "3.3.1", [hex: :parse_trans, repo: "hexpm", optional: false]}, {:ssl_verify_fun, "~>1.1.0", [hex: :ssl_verify_fun, repo: "hexpm", optional: false]}, {:unicode_util_compat, "~>0.7.0", [hex: :unicode_util_compat, repo: "hexpm", optional: false]}], "hexpm", "a4ecdaff44297e9b5894ae499e9a070ea1888c84afdd1fd9b7b2bc384950128e"},
   "html_entities": {:hex, :html_entities, "0.5.2", "9e47e70598da7de2a9ff6af8758399251db6dbb7eebe2b013f2bbd2515895c3c", [:mix], [], "hexpm", "c53ba390403485615623b9531e97696f076ed415e8d8058b1dbaa28181f4fdcc"},
   "idna": {:hex, :idna, "6.1.1", "8a63070e9f7d0c62eb9d9fcb360a7de382448200fbbd1b106cc96d3d8099df8d", [:rebar3], [{:unicode_util_compat, "~>0.7.0", [hex: :unicode_util_compat, repo: "hexpm", optional: false]}], "hexpm", "92376eb7894412ed19ac475e4a86f7b413c1b9fbb5bd16dccd57934157944cea"},
   "jason": {:hex, :jason, "1.4.0", "e855647bc964a44e2f67df589ccf49105ae039d4179db7f6271dfd3843dc27e6", [:mix], [{:decimal, "~> 1.0 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm", "79a3791085b2a0f743ca04cec0f7be26443738779d09302e01318f97bdb82121"},
+  "makeup": {:hex, :makeup, "1.2.1", "e90ac1c65589ef354378def3ba19d401e739ee7ee06fb47f94c687016e3713d1", [:mix], [{:nimble_parsec, "~> 1.4", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "d36484867b0bae0fea568d10131197a4c2e47056a6fbe84922bf6ba71c8d17ce"},
+  "makeup_elixir": {:hex, :makeup_elixir, "1.0.1", "e928a4f984e795e41e3abd27bfc09f51db16ab8ba1aebdba2b3a575437efafc2", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}, {:nimble_parsec, "~> 1.2.3 or ~> 1.3", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "7284900d412a3e5cfd97fdaed4f5ed389b8f2b4cb49efc0eb3bd10e2febf9507"},
+  "makeup_erlang": {:hex, :makeup_erlang, "1.0.2", "03e1804074b3aa64d5fad7aa64601ed0fb395337b982d9bcf04029d68d51b6a7", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm", "af33ff7ef368d5893e4a267933e7744e46ce3cf1f61e2dccf53a111ed3aa3727"},
   "metrics": {:hex, :metrics, "1.0.1", "25f094dea2cda98213cecc3aeff09e940299d950904393b2a29d191c346a8486", [:rebar3], [], "hexpm", "69b09adddc4f74a40716ae54d140f93beb0fb8978d8636eaded0c31b6f099f16"},
   "mimerl": {:hex, :mimerl, "1.2.0", "67e2d3f571088d5cfd3e550c383094b47159f3eee8ffa08e64106cdf5e981be3", [:rebar3], [], "hexpm", "f278585650aa581986264638ebf698f8bb19df297f66ad91b18910dfc6e19323"},
+  "nimble_parsec": {:hex, :nimble_parsec, "1.4.2", "8efba0122db06df95bfaa78f791344a89352ba04baedd3849593bfce4d0dc1c6", [:mix], [], "hexpm", "4b21398942dda052b403bbe1da991ccd03a053668d147d53fb8c4e0efe09c973"},
   "parse_trans": {:hex, :parse_trans, "3.3.1", "16328ab840cc09919bd10dab29e431da3af9e9e7e7e6f0089dd5a2d2820011d8", [:rebar3], [], "hexpm", "07cd9577885f56362d414e8c4c4e6bdf10d43a8767abb92d24cbe8b24c54888b"},
   "ssl_verify_fun": {:hex, :ssl_verify_fun, "1.1.7", "354c321cf377240c7b8716899e182ce4890c5938111a1296add3ec74cf1715df", [:make, :mix, :rebar3], [], "hexpm", "fe4c190e8f37401d30167c8c405eda19469f34577987c76dde613e838bbc67f8"},
   "traverse": {:hex, :traverse, "1.0.1", "5e9b04428e1a82a7de8857ffeecdc37afc94cd702140690c4de2a5e68cbc483d", [:mix], [], "hexpm", "0cf9ec9a974caf36d2d70476af88f6fda469c5d1c08e6341c5cf517b02e01c71"},