MacDownApp / MacDownApp/macdown

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

Open
#396 7 comments 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

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

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

No files, tests, or entry points are named in the issue; first review the existing MacDown settings and menu-option implementation. Done would mean agreeing on a configuration format and search/override behavior, then supporting the requested options through that configuration file.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.