RapiDoc icon indicating copy to clipboard operation
RapiDoc copied to clipboard

Feature Request- Support for Links and ExternalDocs

Open LevinGuy opened this issue 4 years ago • 6 comments

Hi,

RapiDoc does not support Links at the moment, for example: https://github.com/OAI/OpenAPI-Specification/blob/master/examples/v3.0/link-example.yaml

Thanks, Guy

LevinGuy avatar May 31 '20 10:05 LevinGuy

yep neither Links nor External-Docs are supported as yet. We have it in our roadmap but cannot commit to any timeline as we need to collect considerable user-feedbacks and few design alternatives from our design team.

I will leave this open for people to add any suggestions/feedback on these two features

mrin9 avatar Jun 01 '20 18:06 mrin9

Would be a fan to see external docs implemented! Don't have suggestions on how to show this right now.

ralpha avatar Jun 11 '20 23:06 ralpha

just an FYI, you always have the option to use markdown and create internal and external links in your document

mrin9 avatar Jun 12 '20 20:06 mrin9

I'd like to see this implemented too, it would be handy to be able to link to external documentation from the top-level tags, e.g. turning this into a menu item in the sidebar:

tags:
  - name: Additional docs
    externalDocs:
      url: '/url/to/additional/docs'

elipinska avatar Aug 28 '20 09:08 elipinska

+1 for links and externalDocs. New user of RapiDoc and already a huge fan!

wellsb1 avatar Dec 20 '20 19:12 wellsb1

RapiDoc offers many ways to create and customize internal and external links. checkout #414 and example https://rapidocweb.com/examples/links.html on creating links

mrin9 avatar Feb 15 '21 02:02 mrin9

fixed by https://github.com/rapi-doc/RapiDoc/commit/e137d2112b638089e53979cb0fd071a83e36de7d

mrin9 avatar Oct 03 '22 23:10 mrin9