MacDownApp / MacDownApp/macdown
Per-document preference overriding in front-matter
Nobody has claimed this yet.
- Dominant language
- Rich Text Format
- Stars
- 9.8k
- Forks
- 1.2k
- PR merge metrics
- No merged PRs in 30d
Description
The idea is to introduce a special attribute inside the YAML front-matter that can be used to override certain configs inside a document. For example, with underscore enabled in preferences, you can use a front-matter like
_macdown:
underscore: false
to suppress it only in this document. This can also be a good solution to provide per-document TOC support, etc. Obviously we need to choose an obscure key to avoid colliding with normal configs, but would this be compatible with other platforms? What do common platforms do to unrecognised front-matter config keys?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue names no files, tests, or entry points. Start by investigating how YAML front-matter and document preferences are currently handled, then compare how supported platforms treat unrecognised keys. Done should include a settled key name and defined per-document override behavior, including the underscore example and TOC use case.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown, yaml
- Domain
- content
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100