MacDownApp / MacDownApp/macdown

Add UML diagrams support

Open
#224 23 comments 4 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

I think this project could benefit from integrating such a useful feature as UML support for diagrams and flowcharts.
Two open source projects seem to have this feature:
- [PyMdown's SuperFences](http://facelessuser.github.io/PyMdown/Extensions/SuperFences.html)
- [umlsync](https://github.com/umlsynco/umlsync)

Unfortunately I don't have the skills to port this feature. This is just a feature request.

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 names PyMdown's SuperFences and umlsync as reference projects, but it names no MacDown files or tests. Start by reviewing those projects and MacDown's Markdown editor to define the desired UML and flowchart syntax and integration scope. Done would require an agreed design and working diagrams in MacDown.

Written by the indexing model from the issue text.

Assessment

Tech stack
macos, markdown, objective-c
Domain
content, desktop
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.