MacDownApp / MacDownApp/macdown

Support for GitLab flavored markdown math syntax

Open
#720 11 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

GitLab now supports embedded KaTeX rendering but uses a different syntax:

Inline:
~~~
$`x^2`$
~~~

Block:
~~~
```math
x^2
```
~~~

It would be nice if there was an option to enable this syntax variant so that I can use MacDown to edit my GitLab-hosted markdown documents.

See https://docs.gitlab.com/ee/user/markdown.html#math

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 with MacDown's existing Markdown and math-rendering behavior, then compare it with the GitLab math syntax described in the linked documentation. Done means the requested option supports both the `$`-backtick inline form and the fenced `math` block form for GitLab-hosted Markdown documents.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
desktop
Issue type
Feature
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.