MacDownApp / MacDownApp/macdown

Description list

Open
#773 1 comment 1 reaction 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

It would be awesome if MacDown supports description list `

`, also known as definition list. Syntax:

```markdown
kramdown
: A Markdown-superset converter

MacDown
: An awesome Markdown editor
```

which gives HTML

```html


kramdown

A Markdown-superset converter

MacDown

An awesome Markdown editor


```

and renders as


kramdown

A Markdown-superset converter

MacDown

An awesome Markdown editor

See [this answer](https://meta.stackexchange.com/questions/72395/is-it-possible-to-have-definition-lists-in-markdown/121157#121157) for available implementations. Either find new parser (#704) supporting it (built in or by custom extension), or add that to (our?) Hoedown.

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

Review issue #704 and the parser options mentioned in this issue, including Hoedown, before choosing an implementation path. The work is done when the shown description-list syntax produces the corresponding

,
, and
HTML and renders correctly in MacDown.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
desktop
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.