Document sections feature #113

New issue

Open

opened 2020-12-03 05:45:07 +00:00 by lostfictions · 0 comments

lostfictions commented

2020-12-03 05:45:07 +00:00

(Migrated from github.com)

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.)

Sections don't seem to be documented, though it looks like they've been [supported for at least two and a half years](https://github.com/jonschlinkert/gray-matter/blame/master/index.js#L127-L129) -- 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`](https://github.com/jonschlinkert/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.)