Earmark - Elixir's Markdown Converter

[RobertDober]

@RobertDober

While it should be faster to call to_ast|>transform it cannot be used instead of as_html yet
as the API is not yet stable and some subtle differences in the output need to be addressed.

benchmarking shows no speed difference whatsover, indicating that parsing is the dominant speed factor

[MarioFlach]

I’ve just updated to 1.4.1.

When using transform/2, the text content of each node is surrounded by a space. This causes problems with <pre> and <code> tags.

[RobertDober]

good catch I will open an issue

[RobertDober]

Issue: Transformer whitespace inside / around <code> <pre> tags

[RobertDober]

I just released Earmark v1.4.2

1.4.2 2019/10/14

• 296 code for tasks removed from package
  The additional tasks are only needed for dev and have been removed from the hex package. Finally
• PR#293 Nice fix for broken TOC links in README
  Kudos to Ray Gesualdo raygesualdo
• 291 Transformer whitespace inside / around <code> <pre> tags
  The spurious whitespace has been removed
• 289 HTML Problem
  The AST parser can now correctly distinguish between generated AST (from md) and parsed AST (from HTML)
• 288 Metadata allowed to be added to the AST
  The default HTML Transformer ignores metadata in the form of a map with the exception of %{meta: ...}

[RobertDober]

@RobertDober

As reported by @redrabbit additional whitespace around denaturates the output. Desired output

content

because that’s what we do ex(6)> Earmark.as_html(“elixir\nHello\n”) {:ok, “

<code class="elixir">Hello

\n”, } and what…

fixed with last rel

[RobertDober]

1.4.3 2019/11/23

• 309 fenced code allows for more than 3 backticks/tildes now
• 302 Earmark.version returned a charlist, now a string
• 298 Blockquotes nested in lists only work with an indentation of 2 spaces

[niku]

I’ve created a library earmark_hashed_link which adds link to hashed text in a markdown. This library is smarter than just replacing text. It doesn’t add link in comment/blockquote/code etc.

It was easy and fun
Thank you for adding such a nice AST feature.

[RobertDober]

I just released

1.4.5 2020/06/06

This is mostly a bugfix release, as there were edge cases that resulted in
Earmark crashing, notably

• Bare IAL
• unquoted attributes in html tags

Also autolinks (GFM extension) delivered incorrect URLS where parenthesis were involved,
for better GFM compatibility we therefore

• Fixed broken parenthesis links (99% of all cases)

• introduced the same URL encoding/decoding in links and link names of autolinks as GFM does

And last but not least all numeric options in the CLI can now be written with
underlines for readability.

• 343-error-parsing-unquoted-atts

• 342 parens in pure links

• 340 IAL might cause error

• 339 Typos fix
  Kudos to Ondrej Pinka

• 336 Smartypants: Convert three hyphens to em dash
  Kudos to Jony Stoten

• 324 Fix AST for links with nested elements
  Kudos to Wojtek Mach

• 320 Nested Blockquotes

1.4.4 2020/05/01

• 338 Deprecation warnings in mixfile removed

[RobertDober]

I just released Earmark 1.4.6

• Exposes the now stable AST in the quadruple format.

• There are many important bug fixes, all known crashes have been fixed, some issues like code blocks in lists and better HTML support did not make it.

Thanks to all of you for your great bug reporting after 1.4.5 which was a rough one.

Here go the Release Notes:

• 350-some-complicated-autolinks-cut

• 359-unexpected-ws-in-html

• 337-quadruple-ast-format

• 366-simplify-transform
  Kudos to Eksperimental

• 353-oneline-html-tags

• 351-html-tags-without-newlines

• 335-content-inside-table-cells-reversed

• 348-no-crashes-for-invalid-URIs
  Kudos to José Valim

• 347-dialyxir-errors
  Fixed some of them, alas not all

[tfwright]

Hi, thanks for your work on this.

I am still seeing what I think is the issue in https://github.com/pragdave/earmark/issues/359 using "earmark": {:hex, :earmark, "1.4.6", "f14260802d8998f30e1654189a0d1699c4aa7d099eb4dad904eb5f41283a70b2", [:mix], [], "hexpm", "c1653a90f63400d029b783a098f4d70a40418ddff14da4cc156a0fee9e72e8d6"},

Now I don't have whitespace _issues_. beccomes

  Now I don’t have whitespace 
<em>issues</em>  
.

Which the browser renders as Now I don't have whitespace *issues* . (extra space between “issues” and “.”)

Downgrading to 1.4.4 fixes it.

[RobertDober]

can you please open an issue on Github
I will take care of that

Still spurious WS after inline tags

[RobertDober]

Hotfixed above issue

1.4.7 2020/06/29

• 371-still-spurious-ws-after-inline-tags

[tfwright]

Just tested this and it looks great. Thanks for the amazingly quick fix!

[RobertDober]

The introduction of the AST together with some bright ideas of mine made 1.4.5 and 1.4.6 quite bad for all to_html users.

Least I could do, thanks again for your patience.

[RobertDober]

I have just released EarmarkParser v1.4.8

I always wanted to release a new library starting with that high a version

actually I will very soon use EarmarkParser in Earmark

and EarmarkParser is just Earmark without HTML Transfomation and CLI, thusly implementing only what is needed for ex_doc.

I had the following motivations for this step

• Why installing unused code in all libraries that use ex_doc?

• Allow Earmark to work on configurable transformers (maybe also other formats)

• Allow Earmark to use libraries which use ex_doc as soon as ex_doc agrees to use EarmarkParser

Here is the Release Note

EarmarkParser

1.4.8 2020/06/29

This marks the first release of the parser isolated from the rest of Earmark.

It is feature identical to the 1.4.7 release of Earmark.

All releases below were Earmark, all releases above are only EarmarkParser.

Earmark

1.4.7 2020/06/29

• 371-still-spurious-ws-after-inline-tags

[RobertDober]

This is to announce the first split release of Earmark, with all parsing and ast rendering code extracted into EarmarkParser

Earmark

1.4.8 2020/07/01

This is a featureless release.

Its lone purpose is the extraction of all parsing and ast releated code into EarmarkParser.

As it is feature identical to 1.4.7 downgrading in case of problems will be painless.

[RobertDober]

Earmark Hotfix release

1.4.9 2020/07/02

• 375-earmark_parser-missing-in-application

[RobertDober]

I just released a new version of

EarmarkParser

1.4.10 2020/07/18

• 1-text-of-footnote-definitions-not-converted

• 19-use-spdx-in-hex
  Kudos to Chulki Lee

• 10-Missing-space-between-whitspace-separated-items

• 15-hide-private-module
  Kudos to Wojtek Mach

• 14-remove-application-from-mix.exs
  Kudos to Wojtek Mach

• 13-fix-github-link
  Kudos to Wojtek Mach

[RobertDober]

I just published Earmark Version 1.4.10

1.4.10 2020-07-18

• 381-deprecate-earmark-as-ast-usage

• 373-markdown-in-footnotes
  fixed in EarmarkParser v1.4.10

• 334-missing-space-btw-links
  fixed in EarmarkParser v1.4.10

• 378-use-spdx-in-hex
  Kudos to Chulki Lee

• 376-remove-application/0-from-mix.exs
  Kudos to Wojtek Mach