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
|
# EarmarkParser A Pure Elixir Markdown Parser
[](https://github.com/robertdober/earmark_parser/actions/workflows/elixir.yml)
[](https://coveralls.io/github/RobertDober/earmark_parser?branch=master)
[](https://hex.pm/packages/earmark_parser)
[](https://hex.pm/packages/earmark_parser)
[](https://hex.pm/packages/earmark_parser)
## Table Of Contents
<%= xtra.toc :self, gh_links: true, min_level: 2, max_level: 4, remove_gaps: true %>
## Usage
<%= xtra.moduledoc "EarmarkParser", include: :all, wrap_code_blocks: "elixir", headline: 3 %>
## Contributing
Pull Requests are happily accepted.
### mix format
Now we have decided to enforce formatting, when providing PRs please be sure that that `mix format --check-formatted` passes
because it will be tested in the GHA workflow
### Editing README
Please be aware of one _caveat_ when correcting/improving `README.md`.
The `README.md` is generated by the coammand mix task `xtra` from `README.md.eex` and
docstrings by means of `%moduledoc` or `%functiondoc` directives.
Please identify the origin of the generated text you want to correct and then
apply your changes there.
Then issue the mix task `readme`, this is important to have a correctly updated `README.md` after the merge of
your PR.
Thank you all who have already helped with Earmark/EarmarkParser, your names are duely noted in [RELEASE.md](RELEASE.md).
## Author
Copyright © 2014,5,6,7,8,9;2020 Dave Thomas, The Pragmatic Programmers
@/+pragdave, dave@pragprog.com
Copyright © 2020,1,2,3,4,5 Robert Dober
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 -->
|
