MacDownApp/macdown

config file (as in gitconfig or sublimetext) to configure macdown

Open

#396 opened on Jun 28, 2015

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

Description

Could we have a config file (eg: .macdown) to configure the various options of macdown (eg: View>Renders TOC) ?

Even something barebones and subject to change as a start would be great. It's a lot easier to edit a config file (and share it online) than to click on menu items (and more cross-platform too). It also should be easier to implement/maintain and to discover the available options for the user.

Search path could be same as gitconfig (ie a global one, which can be overridden by searching in parent directories)

Format could be json (as in sublimetext) or gitconfig like

https://github.com/uranusjr/macdown/issues/395 also proposes other config file options which would be useful

Contributor guide

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.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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.
mostly clear
Prerequisites
Objective C basicsmacOS file I/OUnderstanding MacDown settings
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
Study MacDown's existing settings management to understand where to add config file support. Explore how other macOS apps implement config files (e.g., gitconfig style parsing). Consider implementing a simple JSON based config file with a search path similar to git's global/local override. Review issue #395 for additional config options.