Parse function rework, cleaner API and documentation

the-alchemists-of-arland / gray-matter-rs

A tool for easily extracting front matter out of a string. It is a fast Rust implementation of gray-matter. Parses YAML, JSON, TOML and support for custom parsers. Use it and let me know by giving it a star!

https://docs.rs/gray_matter

MIT License

37 stars 4 forks source link

Parse function rework, cleaner API and documentation #1

Closed kmaasrud closed 3 years ago

kmaasrud commented 3 years ago

First of all: Thank you for making this! It has been immensely useful in some of my projects.

I want to contribute, and I did have some gripes with how the interface of this crate was solved, so here is a major version rework I've done. The changes are documented in the changelog. I've also written some documentation for the crate.

I hope you agree with the changes I've done :smile: Be sure to leave a review if there is anything you want me to change, and I'll be right on it.

kmaasrud commented 3 years ago

Oops! Seems like I broke the README, sorry about that 😅 Also the doctests on the README are a bit wonky, but seems like you are solving that.

Glad to get your approval on the PR, and very happy to help :smile:

yuchanns commented 3 years ago

Now the v0.2.0 released! :tada: :tada: :tada: