spring-auto-restdocs icon indicating copy to clipboard operation
spring-auto-restdocs copied to clipboard
verified publisher icon ScaCap

Support for pre and code javadoc tags

Open mfolnovic opened this issue 6 years ago • 3 comments

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?

mfolnovic avatar Aug 14 '19 12:08 mfolnovic

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.

fbenz avatar Aug 16 '19 11:08 fbenz

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

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

  • https://daringfireball.net/projects/markdown/syntax#code
  • https://daringfireball.net/projects/markdown/syntax#precode

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

mfolnovic avatar Aug 16 '19 11:08 mfolnovic

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.

serac avatar May 05 '20 11:05 serac