Links

1.0.0

Various ways to create links in RapiDoc

  • Use markdown syntax to create
    • Internal links to various sections of the document
    • External links to other websites
  • Convert headings to links on the Navigation bar
  • Use custom HTMLs and styling to create buttons, links etc

Markdown syntax to create links

Internal Links

RapiDoc assigns auto generated IDs to important sections of the document. You may use these IDs in your markdown syntax to create clickable links to varous sections of the document

below is how RapiDoc will assign IDs to different section

Section ID Note
Overview overview
API Servers servers
Authentications auth
Tags tag--{tag-name} # : ? & = { } and space is replaced by hyphen (-)
Paths/Operations {method}-{path} # : ? & = { } and space is replaced by hyphen (-)

Example: ID of the operation POST /users/find-by-name/{name} is post-/users/find-by-name/-name- (Note: that curlies around the name is replaced by hyphens)

Use Markdown syntax
Now that you understand how the IDs are generated, you may use Markdown syntax to create links to various sections

  [My Link Text](#link-id)

below are some of the links to various sections

External Links

Just Like internal links you can use markdown syntax to create external links

  [Take me to RapiDoc Homepage ](https://mrin9.github.io/RapiDoc/)

Take me to RapiDoc Homepage

HTML Links

RapiDoc allows you to embed custom HTMLs in various slots.

Slot Location
(default) top of the document
header on header bar
footer bottom of document
logo top-left of header
nav-logo top of side navigation bar

below is how you can embed custome HTML content. Unlike markdown links HTML links can be styled by the user, like providing a diffrent color, font etc

<html>
  <head>
    ...
  </head>
  <body>
    <rapi-doc  spec-url = "../specs/links.yaml">
      <slot>
        <a href = "#get-/users/-userId-"> Get User Operation</a>
        <a href = "https://mrin9.github.io/RapiDoc/"> RapiDoc Home </a>
      </slot>
    </rapi-doc>
  </body>
</html>

As an example you can checkout this document's top-right corner, where you will find custom styled HTML Links

Headings as navigation links

You can turn level-1 and level-2 headings to links on Navigation bar using info-description-headings-in-navbar='true' option

<html>
  ...
  <rapi-doc
    spec-url = "../specs/links.yaml"
    info-description-headings-in-navbar='true'
  >
  </rapi-doc>
</html>

As an example you can checkout this document's Navigation Bar, where you will find links to level-1 and level-2 heading