Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Fix broken links to EarmarkParser #475

Merged
merged 1 commit into from
Dec 21, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions lib/earmark.ex
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,15 @@ defmodule Earmark do

### Abstract Syntax Tree and Rendering

The AST generation has now been moved out to [`Earmark.Parser`](https://github.com/robertdober/earmark_parser)
The AST generation has now been moved out to [`EarmarkParser`](https://github.com/robertdober/earmark_parser)
which is installed as a dependency.

This brings some changes to this documentation and also deprecates the usage of `Earmark.as_ast`

Earmark takes care of rendering the AST to HTML, exposing some AST Transformation Tools and providing a CLI as escript.

Therefore you will not find a detailed description of the supported Markdown here anymore as this is done in
[here](https://hexdocs.pm/earmark_parser/Earmark.Parser.html)
[here](https://hexdocs.pm/earmark_parser/EarmarkParser.html).



Expand All @@ -42,7 +42,7 @@ defmodule Earmark do

**N.B.** If all you use is `Earmark.as_ast` consider _only_ using `Earmark.Parser`.

Also please refer yourself to the documentation of [`Earmark.Parser`](https://hexdocs.pm/earmark_parser/Earmark.Parser.html)
Also please refer yourself to the documentation of [`EarmarkParser`](https://hexdocs.pm/earmark_parser/EarmarkParser.html).


The function is described below and the other two API functions `as_html` and `as_html!` are now based upon
Expand Down