jgm/pandoc

--metadata-file with non-markdown contents?

Open

#5,914 opened on Nov 18, 2019

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Haskell (44,133 stars) (3,850 forks)batch import
CLIgood first issuestatus:more-discussion-needed

Description

Currently string fields in --metadata-file are interpreted as pandoc markdown, no matter what input format is specified using --from.

But many JSON files found in the wild have other formats (esp. HTML), and it would be very handy to be able to use them with --metadata-file.

Is there a compelling reason for using pandoc markdown no matter what the format of the main document? @mb21

Contributor guide

Tech stack
None
Domain
cli
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.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Examine how pandoc currently handles metadata file, likely in the source files responsible for option parsing and document processing. Look for the code that reads the metadata file and check if it ignores the from format. Consider whether the fix would involve passing the input format to the metadata reader. Refer to any prior discussion in the comments, particularly the mention of @mb21 for rationale.
--metadata-file with non-markdown contents? · jgm/pandoc#5914 | Good First Issue