Allow access to the generated meta map in the final AST. Needs to be enabled by an option - Githubissues

RobertDober / earmark_parser

The Markdown to AST part of Earmark.

Apache License 2.0

68 stars 26 forks source link

Allow access to the generated meta map in the final AST. Needs to be enabled by an option #47

Closed RobertDober closed 3 years ago

RobertDober commented 3 years ago

Several Ideas come to mind

Option annotations defaulting to nil If annotations is set to e.g. "%%", then lines starting with %% shall create an annotation node
```
%% span elixir 10 800 #f0f000
```
result
```
{"%%", [], ["span elixir 10 800 #f0f000"], %{annotation: "%%"}] 
```
would allow to use many different annotations, but needs post processing before rendering with Earmark
Option annotations defaulting to nil If annotations is set to e.g. "%%", then lines starting with %% shall create an annotation to the node after/before this line
```
%% span elixir 10 800 #f0f000
```
result
```
{"node_from_before_or_after", atts, [content], %{annotation: "%% span elixir..."}] 
```
Maybe the simplest and also best to understand approach would be to attach the annotation on a lexical level (but not on inline)
```
**Elixir** %% 10 800 #f0f000
```
would then result in
```
  {"p", [], [{"i", [], ["Elixir"], %{}}], %{annotation: "%% 10 800 #f0f000"}}
```
N.B. We keep the %% to support different kinds of annotations to mix for postprocessing as Earmark supports an arbitrary number of post processors.