document how to create a dialect

evilstreak / markdown-js

A Markdown parser for javascript

7.69k stars 863 forks source link

document how to create a dialect #249

Open shaunc opened 8 years ago

shaunc commented 8 years ago

The current documentation refers to the code for detailed API docs.

I looked at the code, including the existing dialects, and IMHO the comments don't really explain how to create a dialect. Are there any pointers (besides reading the code) that could help me out? Any info (including comments on this issue) would be welcome.

Thanks!

ezmiller commented 8 years ago

I am looking for the same thing. So +1.

@shaunc: Here is a link to a dialect for the chat system discourse that uses (I think) a fork of markdown-js with dialects: https://github.com/discourse/discourse/blob/master/app/assets/javascripts/discourse/dialects/mention_dialect.js

I'm trying to figure this out as well, so perhaps we can help each other out.