Cross-references
Per the NetFoundry style guide, internal links should use relative paths,
not @site/ or absolute /docs/.... This page exercises every link form.
Relative link to another doc
Relative link with a heading anchor
Anchor link within this page
Jump to the bottom.
Jump to a sibling section.
Sibling section
You jumped here from the in-page anchor above.
Link to an image
Anti-patterns (do not do these)
The style guide forbids these forms even though they may technically work:
[link](@site/docs/foo.mdx)-- uses the@sitealias instead of a relative path.[link](/docs/foo)-- absolute path; breaks ifbaseUrlor the docs route changes.
Use ./foo.mdx or ../section/foo.mdx instead.
Link styling
When inline code is the link text, it should inherit the link color (set in
layout.css via a code { color: inherit }):
--verbose -- inline code inside a link.
External links
Last section
You can jump back to the top of the page.