avh4 / avh4/elm-format

Make sure the normalized markdown is compatible with elm-markdown

Open
#339 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
Haskell
Stars
1.3k
Forks
147
PR merge metrics
No merged PRs in 30d

Description

http://package.elm-lang.org/packages/evancz/elm-markdown/latest is what's used on package.elm-lang.org. So the normalized markdown needs to cause no ambiguities with that engine.

Comparison tool: https://johnmacfarlane.net/babelmark2/

Possibly use the marked js library in integration tests to verify things.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by comparing the normalized output against elm-markdown using the linked Babelmark2 comparison tool. Investigate whether marked can be used in integration tests, and define done as normalized Markdown producing unambiguous, compatible results in the target engine.

Written by the indexing model from the issue text.

Assessment

Tech stack
elm, haskell, javascript
Domain
tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.