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 (930 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (7,686 stars)
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

Research direction
Explore the MacDown codebase to understand how help menu items are added. Look at existing menu items in MainMenu.xib or AppDelegate. Implement a new menu item 'Cheat Sheet' under Help that opens a window or pane displaying Markdown syntax. Consider using a web view or a rich text view with the cheat sheet content.
Tech stack
objective c
Domain
desktop
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Mac Down development setupObjective C
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80