CODEWITHSUNDEEP
markdownredcarpet
Starkers
Starkers

Reputation: 10551

Is the markdown syntax universal?

I've installed the Red Carpet gem and implemented it with my rails app. However, its readme doesn't really contain any information on the syntax.

Should the syntax be obvious, then? All of the git hub markdown appears to be parsed successfully into the expected html in my app, so can I use the git hub markdown as a resource to write a readme for my own application? Or are there slight changes and will I have to test every heading, bullet point and strike though?

If the syntax isn't universal, what is the Red Carpet markdown syntax?

Upvotes: 2

Views: 667

Answers (1)

cincodenada
cincodenada

Reputation: 3087

The original Markdown specification is at DaringFireball.net, which is where Markdown originated. You can usually assume that the syntax outlined there will work as expected, but there's no guarantee, as any independent implementation will usually have its own quirks.

Several implementations of Markdown (Reddit, GitHub, etc) have introduced their own additional syntax, and sometimes some tweaks to how special cases that make sense for their cases. This is generally documented - here's GitHub's outline of what they've added and changed. As @Jonathan Lonowski mentioned, RedCarpet seems to have several extensions that you can choose from that alter or add onto the behavior, depending on your needs.

Upvotes: 3

Related Questions