Support for pre and code javadoc tags

ScaCap / spring-auto-restdocs

Spring Auto REST Docs is an extension to Spring REST Docs

https://scacap.github.io/spring-auto-restdocs/

Apache License 2.0

311 stars 86 forks source link

Support for pre and code javadoc tags #346

Closed mfolnovic closed 10 months ago

mfolnovic commented 5 years ago

Documentation says:

Currently only basic br, p, ul and li tags are supported.

From reading AsciiDoc User Guide, spring-auto-restdocs could support:

<code> - http://asciidoc.org/userguide.html#X77, using a backtick (`)
<pre> - http://asciidoc.org/userguide.html#X105

What do you think?

fbenz commented 5 years ago

This looks helpful. The project supports both Markdown and AsciiDoc and if possible we try to support features for both, but Markdown has its limitations. We will likely not add this soon but if you want it, a PR is welcome.

mfolnovic commented 5 years ago

Awesome. I'll try to find time for this sometime soon.

As for markdown, it seems it's pretty similar:

So it should be easy to support both! :nerd_face:

serac commented 4 years ago

I hope you will consider my contribution. It allowed us to get support for code formatting in our generated API docs, and I would love to avoid having to maintain a fork. Please let me know if there's anything I can to to increase your likelihood of accepting my PR.