MacDownApp / MacDownApp/macdown

Rendering a link with a space between square brackets and parens

Open
#1,044 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement upstream
Dominant language
Rich Text Format
Stars
9.8k
Forks
1.2k
PR merge metrics
No merged PRs in 30d

Description

Right now MacDown renders `[this] (link)` as a link. But many Markdown engines (including the one in use right here on GitHub) consider the space between the square brackets `[]` and the parens `()` as significant and will not render the link unless the space is eliminated, as in `[this](link)`.

Would it be possible for MacDown to include a Markdown Preference that is something like "Allow spaces between parts of link" which is checked for the current behavior but can be unchecked if we would like MacDown to enforce the stricter behavior?

Such an option would help my users identify these spaces as errors before they upload the `.md` files to their Jekyll sites.

Contributor guide

Open the contributing guide

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

The issue concerns MacDown's Markdown link rendering and a user preference controlling whether spaces are accepted between link brackets and parentheses. Start by locating the rendering and preference entry points, then verify that the unchecked setting rejects `[this] (link)` while the checked setting preserves current behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown, objective-c
Domain
desktop
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.