MacDownApp/macdown

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

Open

#440 opened on Sep 18, 2015

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Objective-C (7,686 stars) (930 forks)batch import
enhancementhelp wanted

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

Tech stack
objective c
Domain
desktopdocumentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
familiarity with macOS app developmentbasic knowledge of Objective C
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Examine the MacDown codebase to locate the Help menu implementation. Add a new menu item 'Cheat Sheet' that opens a pane or window displaying a Markdown syntax cheat sheet. Consider creating a new view controller or bundling an HTML file for the cheat sheet content. No comments or PRs linked; the issue remains open since 2015.