MacDownApp / MacDownApp/macdown

feature request: help links to Markdown syntax and demontrations / cheat sheets

Open
#440 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

MacDown is a fantastic product!

I tend for forget particular syntax. Sublime Text's "Markdown Preview" solves this by including a cheat sheet.

I can see a few ways of doing this, others might have great ideas. It also seems like a small feature.

Design 1: Help > cheat sheet (opens the cheat sheet in a pane, pretty self explanatory)

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 the proposed Help > cheat sheet entry described in the issue and determine how Markdown syntax references, demonstrations, or cheat sheets should be presented in MacDown. Done means users can reach useful Markdown help from the application, but the issue does not specify the content source, files, tests, or exact design.

Written by the indexing model from the issue text.

Assessment

Tech stack
macos, markdown
Domain
desktop, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.