openresty / openresty/opm

Markdown parsing mistakes

Open
#95 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Lua
Stars
485
Forks
76
PR merge metrics
No merged PRs in 30d

Description

The URL portion of links [text](url) should trim all leading and trailing whitespace from within the parenthesis, including newlines. GitHub parses it this way, but the OPM website does not.

I am referring to wrapping long URLs like this:

Some long line of text, where the link may occur [in the middle](
https://example.com/some-long-url-that-should-be-wrapped)

I use that often in GitHub READMEs.

Additionally, bold inline code:

**`something`**

is not parsed correctly, the ending ** is ignored and it creates a so-called "POD error" Unterminated B<...> sequence.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the Markdown parser entry points for link destinations and inline code, then reproduce both examples from the issue. Add regression coverage for whitespace-wrapped URLs and bold inline code, and confirm the parser no longer reports the shown POD error.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua, markdown
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.