search

mashery / iodocs

Interactive API documentation system
MIT License
1.89k stars 415 forks source link

Formatting support for description or synopsis + UTF-8 #92

Open ediri opened 11 years ago

ediri commented 11 years ago

At the moment there is no way to use formatting (e.g. HTML) in the description or synopsis tag. Same is for UTF-8 support

It would be nice to have these feature enabled. Or maybe I am missing something in my configuration...

peterquirk commented 10 years ago

An explicit or implicit reference to a separate markdown file would be very useful. The implicit reference would look for name_of_api.md and incorporate the formatted text directly if present.

jsfenfen commented 10 years ago

+1. Links to external sources would be really helpful in the description field for explaining odd or complex parameters.

mansilladev commented 10 years ago

I was working on integrating markdown module so you'd just have markdown inline on your JSON config. Maybe that's the first pass and we can tackle external MD files on the next?