MacDownApp / MacDownApp/macdown

Update header parser for apparent changes to GitHub

Open
#791 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Headers in Markdown are specified like this:

##This is an H2

This should render like so in GitHub:

This in an H2

However, I've recently noticed that headers specified without a space between the # and the first character are rendering as ##This is an H2 on GitHub pages. I'm not sure if this is intentional, but MacDown should match GitHub's behavior.

Here's a test H2 without the space, so we can see if GitHub has changed their behavior:

##This is an H2 without a space

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

Start by reproducing the Markdown example in MacDown and compare its rendering with the GitHub behavior described in the issue. Trace the Markdown parsing or rendering entry point used for headers without a space after the hash marks. Done means MacDown matches GitHub's current output for that example, with a regression check for the no-space H2 case.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
desktop
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 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.