search

carbon-io / carbond

MIT License
2 stars 5 forks source link

Backticks are not interpreted correctly in generated documentation #205

Closed rmiyashiro closed 7 years ago

rmiyashiro commented 7 years ago

I think there's a bug in the underlying library we/APIBlueprint is using to interpret markdown strings, though I have not been able to find an existing issue by googling. Both inline and block backticks are not working right:

`code`
```
code
```

Both of the above appear as just plain text with the backticks included instead of rendering as proper preformatted text. This affects regular markdown docs as well as Aglio.

willshulman commented 7 years ago

Greg can you discuss with Robert and see if you can help?

gregbanks commented 7 years ago

removed html escaping from description blocks on app, endpoints, and operations:

https://github.com/carbon-io/carbond/commit/b74876e85ca4ca736ddc00231e09e2466cb5cc86

willshulman commented 7 years ago

Robert let us know if this fixes it

rmiyashiro commented 7 years ago

Yup, it's fixed now