Skip to content

Commit

Permalink
Call for maintainer [skip-ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
RobertDober committed Sep 26, 2023
1 parent 1c63f8b commit a3a7557
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 7 deletions.
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ and any changes you make in this file will most likely be lost

# Earmark—A Pure Elixir Markdown Processor

# Earmark is looking for a New Maintainer (the old one is old now)

If you are interested please mail me on the address below or just open an issue.

[![CI](https://github.com/pragdave/earmark/actions/workflows/elixir.yml/badge.svg)](https://github.com/pragdave/earmark/actions/workflows/ci.yml)
[![Coverage Status](https://coveralls.io/repos/github/pragdave/earmark/badge.svg?branch=master)](https://coveralls.io/github/pragdave/earmark?branch=master)
[![Hex.pm](https://img.shields.io/hexpm/v/earmark.svg)](https://hex.pm/packages/earmark)
Expand Down Expand Up @@ -52,7 +56,7 @@ returning the device and the string to be output.

### Earmark.Options

This is a superset of the options that need to be passed into `EarmarkParser.as_ast/2`
This is a superset of the options that need to be passed into `Earmark.Parser.as_ast/2`

The following options are proper to `Earmark` only and therefore explained in detail

Expand All @@ -63,10 +67,10 @@ The following options are proper to `Earmark` only and therefore explained in de
- `smartypants`: boolean use [Smarty Pants](https://daringfireball.net/projects/smartypants/) in the output
- `ignore_strings`, `postprocessor` and `registered_processors`: processors that modify the AST returned from

EarmarkParser.as_ast/`2` before rendering (`post` because preprocessing is done on the markdown, e.g. `eex`)
Earmark.Parser.as_ast/`2` before rendering (`post` because preprocessing is done on the markdown, e.g. `eex`)
Refer to the moduledoc of Earmark.`Transform` for details

All other options are passed onto EarmarkParser.as_ast/`2`
All other options are passed onto Earmark.Parser.as_ast/`2`

### Earmark.Options.make_options/1

Expand Down Expand Up @@ -155,7 +159,7 @@ functions are public in `Earmark`

### Earmark.Internal.as_ast!/2

A wrapper to extract the AST from a call to `EarmarkParser.as_ast` if a tuple `{:ok, result, []}` is returned,
A wrapper to extract the AST from a call to `Earmark.Parser.as_ast` if a tuple `{:ok, result, []}` is returned,
raise errors otherwise

```elixir
Expand Down Expand Up @@ -215,7 +219,7 @@ And here is how it is used inside a template

#### Structure Conserving Transformers

For the convenience of processing the output of `EarmarkParser.as_ast` we expose two structure conserving
For the convenience of processing the output of `Earmark.Parser.as_ast` we expose two structure conserving
mappers.

##### `map_ast`
Expand Down Expand Up @@ -451,7 +455,7 @@ tools has emerged yet.
Walks an AST and allows you to process it (storing details in acc) and/or
modify it as it is walked.

items is the AST you got from EarmarkParser.as_ast()
items is the AST you got from Earmark.Parser.as_ast()

acc is the initial value of an accumulator that is passed to both
process_item_fn and process_list_fn and accumulated. If your functions
Expand Down Expand Up @@ -499,7 +503,7 @@ commented text to be left out
...(1)>
...(1)> text
...(1)> """
...(1)> {:ok, ast, []} = EarmarkParser.as_ast(markdown)
...(1)> {:ok, ast, []} = Earmark.Parser.as_ast(markdown)
...(1)> Restructure.walk_and_modify_ast(ast, nil, italics_maker, comment_remover)
{[
{"p", [],
Expand Down
4 changes: 4 additions & 0 deletions README.md.eex
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@

# Earmark—A Pure Elixir Markdown Processor

# Earmark is looking for a New Maintainer (the old one is old now)

If you are interested please mail me on the address below or just open an issue.

[![CI](https://github.com/pragdave/earmark/actions/workflows/elixir.yml/badge.svg)](https://github.com/pragdave/earmark/actions/workflows/ci.yml)
[![Coverage Status](https://coveralls.io/repos/github/pragdave/earmark/badge.svg?branch=master)](https://coveralls.io/github/pragdave/earmark?branch=master)
[![Hex.pm](https://img.shields.io/hexpm/v/earmark.svg)](https://hex.pm/packages/earmark)
Expand Down

0 comments on commit a3a7557

Please sign in to comment.