Add more examples

[wooorm]

Subject of the feature

remark has a giant ecosystem. This project is used a lot. It seems to be a good place to add common case examples of using math, footnotes, gfm, syntax highlighting, in the readme.

Problem

Confusing to newcomers. Most things can be solved by plugins. But it’s unclear how.

Expected behavior

A couple of examples. Not too many.

[ChristianMurphy]

Examples could help, another approach, taken in #428 but could also be applied to current is using Storybook to create interactive examples.

[wooorm]

Could also work! I definitely don’t want it exhaustive!

Somewhere in between might be manageable in storybook.

Where’s the line? What should go where?

[ChristianMurphy]

I think initially putting things in the readme is a good start.
I like storybook because it can also be used as a reference for questions/issues that involve plugins.

I definitely don’t want it exhaustive!

Likewise, usually 5-25 examples in a storybook can cover the vast majority of use cases.

Where’s the line? What should go where?

I usually would put a basic example in the readme, plus maybe one with an extension, and the rest would go in storybook.

[wooorm]

I’m assuming GFM to be the most used plugin, so it can probably go in the main Use example. We can skip footnotes as it’s very similar.

Math is interesting because it means a syntax extension and handling nodes.

Syntax highlighting is interesting because you’re dealing with potentially 500kb of JS. And can go with the plugin or react-syntax-highlighter approach. #191

These seem enough for the readme?