search

mojombo / tomdoc

A flexible code documentation specification with human readers in mind.
333 stars 47 forks source link

Use Markdown for simple markup #33

Closed dasch closed 12 years ago

dasch commented 12 years ago

Having a way to denote inline code blocks, adding emphasis to words and paragraphs, adding external links, and arbitrary lists would be really nice.

I think Markdown is the perfect fit for TomDoc, as it builds on the same principle (readability as plaintext,) while allowing for machine parsing.

mojombo commented 12 years ago

I think Markdown is way overkill for TomDoc. About the only thing I could be convinced to include is a syntax for inline code using backticks. Of course, you can just use those right now if you please.

dasch commented 12 years ago

Inline backticks would probably suffice for most purposes, although I do use lists extensively, and feel that they're valuable in documentation.

mojombo commented 12 years ago

I do use lists extensively, and feel that they're valuable in documentation.

Sure, lists are great. They show up nicely in plaintext too, though, so I don't see it as a huge issue.

dasch commented 12 years ago

I guess I have to accept that TomDoc is only meant to be displayed verbatim :-)