sdk_style.md: shortcut notation for page links

This commit is contained in:
Yann Cébron 2021-09-23 10:25:57 +02:00
parent c861ea20c7
commit d2a3f97782

View File

@ -56,6 +56,9 @@ Consistent text styles are used to standardize references and keywords:
### Links ### Links
Links are handled as standard Markdown links and can be anchored to external sites, pages within the sites, or headings in the sites. Links are handled as standard Markdown links and can be anchored to external sites, pages within the sites, or headings in the sites.
To link to a page within the site using its `title:` as link text, use shortcut notation `[](page.md)`{disable-links}.
When a Markdown header is converted to an HTML header, it is assigned an ID so that it can be linked. When a Markdown header is converted to an HTML header, it is assigned an ID so that it can be linked.
For example, `## Introduction` gets the ID of `introduction`, and can be linked either in the same page or cross-page as described below. For example, `## Introduction` gets the ID of `introduction`, and can be linked either in the same page or cross-page as described below.