Referencing Content in DX Portal

Beta notice: Our current linking solution is in beta. We might modify it a bit in the future.

You can use Markdown links to link to generated and user-written content in the portal. To maintain portability of links across SDK documentations, we built our own linking solution.

There’s a shortcut to getting the link of a heading from the portal: if you double click on a heading, the portal will log the link to the heading on the browser’s developer console (usually accessed by pressing F-12 key).

If a link for the heading is not logged to the developer console, linking to it is not supported.

The table below describes how links to various headings or sections are built:

Reference TypeFormat
How to install$h/__how_to_install
How to build$h/__how_to_build
How to use$h/__how_to_use
How to test$h/__how_to_test
Api errors$h/__api_errors
Endpoint Group$e/{Endpoint Group Name}
Endpoint$e/{Endpoint Group Name}/{Endpoint Name}
Custom-type$m/{Model Name}
User-written guide$h/__guides/{Guide Title}
User-written guide’s heading$h/__guides/{Guide Title}/{Heading one}
User-written guide’s nested heading$h/__guides/{Guide Title}/{Heading one}/{Nested heading}

So, to reference a guide titled “Registering Your Application”, the link in markdown syntax would be:

[put your link text here]($h/__guides/Registering+Your+Application)

Please note that

  • The snippet { ... } indicates that you must write the URL-encoded form of the title or the name you are referring to, without the curly brackets. To be specific, we’re using System.Net.WebUtility.UrlEncode() method from .NET framework for URL-encoding.
  • The links are case-sensitive.

Have questions? Submit a request.