This repository was archived by the owner on Jul 2, 2026. It is now read-only.
Repository navigation
Expand file tree
/
Copy pathREADME.md.eex
More file actions
67 lines (36 loc) · 2.63 KB
/
Copy pathREADME.md.eex
File metadata and controls
67 lines (36 loc) · 2.63 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
<%= xtra.do_not_edit_warning template: template %>
# Earmark—A Pure Elixir Markdown Processor
[](https://github.com/pragdave/earmark/actions/workflows/ci.yml)
[](https://coveralls.io/github/pragdave/earmark?branch=master)
[](https://hex.pm/packages/earmark)
[](https://hex.pm/packages/earmark)
[](https://hex.pm/packages/earmark)
## Disclaimer
*Important:* Earmark is a program that translates markdown to html. Markdown is inherently **unsafe**. Earmark does not and cannot sanitize
unsafe markdown input, as it can contain, verbatim HTML or Javascript amongst other issues.
**DO NOT USE ON UNTRUSTED INPUT!**
**N.B.**
This README contains the docstrings and doctests from the code by means of [extractly](https://hex.pm/packages/extractly)
and the following code examples are therefore verified with `ExUnit` doctests.
## Table Of Content
<%= xtra.toc :self, gh_links: true, min_level: 2, max_level: 4, remove_gaps: true %>
## Options
<%= xtra.moduledoc "Earmark.Cli.Implementation", wrap_code_blocks: "elixir", headline: 3 %>
<%= xtra.moduledoc "Earmark.Options", include: :all, wrap_code_blocks: "elixir", headline: 3 %>
<%= xtra.moduledoc "Earmark.Internal", include: :all, wrap_code_blocks: "elixir", headline: 3 %>
<%= xtra.moduledoc "Earmark.Transform", wrap_code_blocks: "elixir", headline: 3 %>
<%= xtra.functiondoc "Earmark.Restructure.walk_and_modify_ast/4", wrap_code_blocks: "elixir", headline: 4 %>
<%= xtra.functiondoc "Earmark.Restructure.split_by_regex/3", wrap_code_blocks: "elixir", headline: 4 %>
## Contributing
Pull Requests are happily accepted.
Please be aware of one _caveat_ when correcting/improving `README.md`.
The `README.md` is generated by `Extractly` as mentioned above and therefore contributors shall not modify it directly, but
`README.md.eex` and the imported docs instead.
You need to run `mix xtra` after getting the dependencies to generate the `README.md` file.
Thank you all who have already helped with Earmark, your names are duly noted in [RELEASE.md](RELEASE.md).
## Author
Copyright © 2014,5,6,7,8,9, 2020,1,2 Dave Thomas, The Pragmatic Programmers & Robert Dober
@/+pragdave, dave@pragprog.com & robert.dober@gmail.com
# LICENSE
Same as Elixir, which is Apache License v2.0. Please refer to [LICENSE](LICENSE) for details.
<!-- SPDX-License-Identifier: Apache-2.0 -->