jonschlinkert / gray-matter

Smarter YAML front matter parser, used by metalsmith, Gatsby, Netlify, Assemble, mapbox-gl, phenomic, vuejs vitepress, TinaCMS, Shopify Polaris, Ant Design, Astro, hashicorp, garden, slidev, saber, sourcegraph, and many others. Simple to use, and battle tested. Parses YAML by default but can also parse JSON Front Matter, Coffee Front Matter, TOML Front Matter, and has support for custom parsers. Please follow gray-matter's author: https://github.com/jonschlinkert
https://github.com/jonschlinkert
MIT License
3.97k stars 138 forks source link

Document sections feature #113

Open lostfictions opened 3 years ago

lostfictions commented 3 years ago

Sections don't seem to be documented, though it looks like they've been supported for at least two and a half years -- I only discovered their existence by looking at the examples, and it turned out they were exactly what I needed for my particular issue.

It would be great to see the section and sections options mentioned in the readme, even if users are pointed to section-matter for the bulk of the explanation.

Relatedly, it would be nice to see #80 merged so that the feature is more usable/discoverable. (Also adding a reference to #51 here so that other folks landing on it from a search can be pointed to something a bit more recent.)