Skip to content

Cross-referencing

Learn how to cross-reference other pages on Braze Docs. To cross-reference pages outside Braze Docs, use standard Markdown syntax.

Prerequisites

If you haven’t already, complete the steps for Contributing to Braze Docs.

Create a cross-reference

When creating a cross-reference, you can either use the in-line method or reference-style method. The in-line method prioritizes clarity, while the reference-style method prioritizes readability.

Open the relevant Markdown file, then create your in-line link.

1

[LINK_TEXT]({{site.baseurl}}/SHORT_URL)

Replace the following:

Placeholder Description
LINK_TEXT The page title or related action.
SHORT_URL The page URL with https://www.braze.com removed.

Your in-line link should be similar to the following:

1

Before continuing, [create your SSH token]({{site.baseurl}}/docs/developer_guide/platform_wide/sdk_authentication).

1

<a href='[SHORT_URL]'>[LINK_TEXT]</a>

Replace the following:

Placeholder Description
LINK_TEXT The page title or related action.
SHORT_URL The page URL with https://www.braze.com removed.

Your in-line link should be similar to the following:

1

To learn about the different custom attribute data types you can use to segment users, view <a href="/docs/user_guide/data_and_analytics/custom_data/custom_attributes/#custom-attribute-data-types">Custom attribute data types</a>.

Open the relevant Markdown file, then create your reference-style link.

1

[LINK_TEXT][REFERENCE_NUMBER]

Replace the following:

Placeholder Description
LINK_TEXT The page title or related action.
REFERENCE_NUMBER Assign any positive integer that’s not already assigned to another reference-style link on this page.

Your references should be similar to the following:

1

Before continuing, [create your SSH token][2]. When you're finished, see [Step 2: Uploading your token][5].

At the bottom of the page, you’ll add the related links.

1

[REFERENCE_NUMBER]: {{site.baseurl}}SHORT_URL

Replace the following:

Placeholder Description
REFERENCE_NUMBER The number of the reference you’d like to link to.
SHORT_URL The page URL with https://www.braze.com/docs removed.

Your links should be similar to the following:

1
2

[2]: {{site.baseurl}}/developer_guide/platform_wide/sdk_authentication/
[5]: {{site.baseurl}}/developer_guide/platform_wide/swift#step-2-uploading-your-token
  Edit this page on GitHub
HOW HELPFUL WAS THIS PAGE?
New Stuff!