srid/emanote

Switch from `commonmark-hs` to Pandoc for parsing Markdown

Open

#264 opened on Mar 13, 2022

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Haskell (78 forks)github user discovery
help wanted

Repository metrics

Stars
 (948 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

But emanote uses commonmark-hs (from same author) to parse Markdown. I'm okay with us switching to parsing with Pandoc. The Wikilink extension, as well as the HashTag extension, would be the main thing to port over.

Originally posted by @srid in https://github.com/srid/emanote/discussions/250#discussioncomment-2145470

Contributor guide

Research direction
Study the current Markdown parsing in emanote using commonmark hs, then explore Pandoc's API and how to implement the Wikilink and HashTag extensions in Pandoc. Finally, replace the parser and test thoroughly.
Tech stack
haskell
Domain
backenddocumentation
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
HaskellPandoc
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25