Ajedi32 / metalsmith-metafiles

A Metalsmith plugin to read file metadata from separate files (as an alternative to frontmatter)
MIT License
6 stars 2 forks source link

Update README opening section to explain why you might choose this plugin over frontmatter #11

Closed Ajedi32 closed 8 years ago

Ajedi32 commented 8 years ago

Why choose this method over frontmatter? While frontmatter is a convenient way to set metadata in your files, it can cause problems with syntax hilighters, linters, and other tools which expect your source files to contain only valid syntax from the language they are written in. (Frontmatter isn't valid CSS, HTML, JavaScript, etc.) Putting your metadata in separate files eliminates these problems.