Add examples for newcomer developers #566
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1d706d6 to
c5ff600
Compare
|
This is super helpful. Before looking into this repo, I think the node is limited to Event in pulldown_cmark - Rust. Turns out there is Tag in pulldown_cmark - Rust. I hope this PR merged soon. |
|
Great to see more examples; this is almost always the fastest way to learn for newcomers. @raphlinus I know you said you're not giving this repo a ton of time but for documentation based enhancements can we push these through? I know you said you were open to others being more involved in the repo ... I would like to help if I can but would probably need a bit of time from you to start to make sure my judgement is sound :) |
Collaborator
|
Sorry for the long delay on reviewing this. This looks useful for newcomers to the repo, so I'll merge it. Thanks! |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The purpose of this commit is to help newcomers i.e. developers who are discovering pulldown-cmark for the first time.
This commit has 3 independent items and could easily be split into multiple commits if that's more suitable:
A new example usage code block for "hello world" in the README.
A new program "examples/parser-map-event-print" that uses a parser map in order to print events. This code is similar to the existing "examples/event-filter", plus has a focus on simple printing rather than on content rewriting.
A new program "examples/parser-map-tag-print" that uses a parser map in order to print tags. This code is similar to the existing "examples/event-filter", plus has a focus on start tags including extensions e.g. tables.