-
Notifications
You must be signed in to change notification settings - Fork 228
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
Pulldown-cmark mdBook #863
Comments
As someone currently using |
I mean docs.rs is good for the API and a basic usage, but a book could provide a 'Getting started' chapter, and collecting examples currently only available in the code repository (https://github.com/pulldown-cmark/pulldown-cmark/tree/master/pulldown-cmark/examples). Furthermore, the full specs could be easily checked (and with a great search engine!) instead of being only in the code repository and it could be also a good place for developers documentation, which is currently almost missing. |
The crate documentation of docs.rs is good for learning the API, but some things like examples and specs are difficult to find for end users, and a mdBook would improve a lot the user experience for these types of things.
The text was updated successfully, but these errors were encountered: