Anchor tags in Postman documentation
Number of APIs: 2
This page provides examples of anchor tag usage in Qodex documentation!
Section Headings
Large section headings will show up in the left-hand nav bar, and can also be linked to using Markdown as shown below.
[Large heading](#large-heading)
See Large heading as an example:
To create a section heading in Markdown, just add # before the heading text:
Large heading
Markdown:
# Large Heading
Can be linked to.
Medium heading
Markdown:
## Medium heading
Useful for organization, but can't be linked to.
Small heading
Markdown:
### Small heading
Still useful for organization.
Small(er) heading
Markdown:
### Small(er) heading
Still useful for organization.
Linking to folders and requests
On any Qodex documentation page, each folder and request (as well as the is assigned a unique anchor tag ID. You can find this by clicking on the request or folder in the left nav bar, and looking at the end of the resulting URL.
Here is an example for the GET Requests folder on this page:
https://documenter.getQodex.com/view/5293839/Rztms92o# c892f021-30c4-4595-9e9d-c877b4423352
The id shown above can be used to link elsewhere in your docs page, using the following Markdown syntax:
[Link Text](#abcdef01-2345-6789-abcd-ef0123456789)
The id can't be customized, but it does persist unless the underlying folder or request is deleted.
Rendered example:
Sections linked using anchor tags: