search

ariabuckles / simple-markdown

JavaScript markdown parsing, made simple
MIT License
516 stars 101 forks source link

Documentation: docs for the parsed syntax tree types #60

Open pjlevitt opened 5 years ago

pjlevitt commented 5 years ago

Could you provide documentation for the parsed syntax tree documentation types, supported mark down tags -> types, etc?

Would be really helpful in creating a custom "renderer".

ariabuckles commented 5 years ago

Hi @pjlevitt !

That's a great idea. I probably won't be able to get to it for a while, as I'm currently really busy with work, but I'll try to address it when I can.

If it's helpful in the short term, when I'm writing a custom outputter/renderer, I tend to look through the defaultRules declaration. The html: output functions are mostly pretty simple, and show all of the fields on each type of AST parse node. (Also, html: null means the rule is parse-only, and when parsed, it will use a different output function. For example, nptable uses the table AST parse node format and output function.)