Write Output

[daxpedda]

It can be useful to write the expected output to a file instead of using assert_sync to only check for differences.
I wasn't able to find a way to do this.

[zheland]

Thank you for your observation.

Both readme and docs contain their own unique features that cannot be restored when converting back.
For example, readme contains unique badge paragraphs.
And docs supports hiding code that is still used for compilation.

Because of this, I originally made this crate in such a way that both readme and docs are converted to something common and then compared.
In the near future I don't plan to re-do the crate so that you can get the corresponding readme from docs and docs from readme without taking into account the unique content.

But I have added methods like CMarkDocs::iter_events and CMarkReadme::iter_events with which you can easily access the pulldown-cmark events and then use a crate like pulldown-cmark-to-cmark to convert that into a string.

[daxpedda]

In the near future I don't plan to re-do the crate so that you can get the corresponding readme from docs and docs from readme without taking into account the unique content.

And it's not needed by me! The solution with CMarkDocs::iter_events and pulldown-cmark-to-cmark is amazing and was really easy to use, thank you.

I noticed that it adds \ in a lot of places that seem confusing to me, for example:

that allow it, which are: [`Debug`], [`Hash`], [`Ord`\], [`PartialOrd`\],
\[`PartialEq`\] and [`Zeroize`\].

Maybe this is fixed in a newer version, I had to use pulldown-cmark-to-cmark 0.7 because readme-sync is still relying on pulldown-cmark 0.8, but otherwise it works great.