Support writing frontmatter in multiple formats. #933
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Deploy preview ready! Built with commit 5b3e3ab |
|
Deploy preview ready! Built with commit 5b3e3ab |
tech4him1
force-pushed
the
563-multi-frontmatter
branch
2 times, most recently
from
a8d5053
to
d20dc8e
Compare
tech4him1
force-pushed
the
563-multi-frontmatter
branch
2 times, most recently
from
e86a9b1
to
ec09208
Compare
Currently we store JSON as a single line in files. We should prettify it like we do the other formats.
Right now we can read TOML or JSON frontmatter by inferring, but we can only write frontmatter in YAML. This change allows the frontmatter format to be explicitly set for reading and writing.
tech4him1
force-pushed
the
563-multi-frontmatter
branch
from
ec09208
to
c57858a
Compare
tech4him1
force-pushed
the
563-multi-frontmatter
branch
from
386bbf8
to
5b3e3ab
Compare
tech4him1
changed the title
erquhart
approved these changes
Jan 29, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
- Summary
Right now we can read TOML or JSON frontmatter by inferring, but we can only write frontmatter in YAML. This change allows the frontmatter format to be explicitly set for reading and writing.
The
formatoptions are:frontmatter(default): Infer frontmatter format if possible, write to YAML.json-frontmatter: Read and write JSON frontmatter ({}delims), ignore other formats.toml-frontmatter: Read and write TOML frontmatter (+++delims), ignore other formats.yaml-frontmatter: Read and write YAML frontmatter (---delims), ignore other formats.For now, we do not support custom delimiters, we use
---for YAML,+++for TOML, and{}for JSON. If a frontmatter format is explicitly specified, and there is frontmatter inside other delimiters, the frontmatter will be ignored, and it will be included as part of the body text.Closes #563.
- Test plan
- Description for the changelog
Support writing frontmatter in multiple formats.
- A picture of a cute animal (not mandatory but encouraged)