Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support writing frontmatter in multiple formats. #933

Merged
merged 7 commits into from
Jan 29, 2018

Conversation

tech4him1
Copy link
Contributor

- 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 format options 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)

@verythorough
Copy link
Contributor

verythorough commented Dec 18, 2017

Deploy preview ready!

Built with commit 5b3e3ab

https://deploy-preview-933--netlify-cms-www.netlify.com

@verythorough
Copy link
Contributor

verythorough commented Dec 18, 2017

Deploy preview ready!

Built with commit 5b3e3ab

https://deploy-preview-933--cms-demo.netlify.com

@tech4him1 tech4him1 force-pushed the 563-multi-frontmatter branch 2 times, most recently from a8d5053 to d20dc8e Compare December 20, 2017 22:15
@tech4him1 tech4him1 force-pushed the 563-multi-frontmatter branch 2 times, most recently from e86a9b1 to ec09208 Compare January 2, 2018 23:47
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 tech4him1 changed the title WIP: Support writing frontmatter in multiple formats. Support writing frontmatter in multiple formats. Jan 3, 2018
@erquhart erquhart merged commit 756d562 into master Jan 29, 2018
@erquhart erquhart deleted the 563-multi-frontmatter branch January 29, 2018 22:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add option to write front matter in TOML or JSON format
3 participants