Add README section on Syntax Highlighting

[niksurff]

I thought this might close #114. Info taken from here.

I'll be doing some research into how this could be accomplished in other editors.

[giuseppeg]

Awesome! I was thinking of adding a FAQ section at the bottom of README.md with a few <summary> blocks to answer the most common / related questions, like Next.js does https://github.com/zeit/next.js#faq .

To give you an idea every once somebody asks about this

Warning: Unknown prop `jsx` on <style> tag. Remove this prop from the element. For details, see https://fb.me/react-unknown-prop
    in style (created by Unknown)
    in nav (created by Unknown)
    in Unknown (created by Unknown)
    in div (created by Unknown)
    in Unknown (created by App)
    in App

which means that for some reason styled-jsx didn't run completely (eg. they are not using next@2.0.0-beta)

[niksurff]

Being blunt, I'm very much against FAQs. 🔫

It's a comfortable place to stuff in content that seemingly doesn't fit in anywhere else. In my opinion this only pushes the problem to the end user (who honestly doesn't know which questions are frequently asked). I'd rather think a little longer about where said content belongs and add appropriate sections if necessary. Note that this is very much subjective. But it's hard to get rid of a FAQ section once it's there [1].

The proposed Syntax Highlighting section might seem superfluous at the moment due to it having only one entry. But I'm hoping it will grow over time as we find solutions for other editors. I also believe it's important enough to deserve it's own section.

As for your example: It might fit in a section Common Pitfalls or better yet in the Next.js docs. So we can link to it when this type of error comes up.

In any case: No ❤️ feelings. In the end it's not that big of a deal.

[1]: I'm working on documentation improvements for Next.js. And I'm trying to get rid of the FAQ section for above reasons. Also I don't want to step on anybody's toes and would be happy to back away.

[niksurff]

To conclude: I wouldn't wait for more editors to make it to the list before merging. Personally I'm using VS Code where it's currently not supported. If you'd rather add it as a FAQ, feel free—or I can take care of that. ✌️

I'd just like to see this documented somewhere and—most importantly—have the satisfaction of closing an issue. 🤘

[giuseppeg]

That's totally ok and makes sense. There are actual FAQ like the example I mentioned, but it is not a big deal we can add a paragraph for that later.