Shortcodes

Welcome to the Shortcode kitchen sink!

This page contains examples of the different shortcode options you have available when creating a new documentation page.


Callout

A Callout can easily be added by using the callout shortcode.

A callout looks like this:

My cool callout

Mom's spaghetti

One with a link:

Callout with link

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam condimentum orci et velit facilisis, ut condimentum ligula porttitor. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.

Here is a link

Example code:

{{< callout title="My cool callout" >}}
  Mom's spaghetti
{{< /callout >}}

Example code (with link):

{{< callout title="Callout with link" linkText="Here is a link" linkUrl="#" >}}
  Mom's spaghetti
{{< /callout >}}

Secondary Callout

A Secondary callout can easily be added by using the secondaryCallout shortcode.

Unlike the callout shortcode, the secondaryCallout shortcode has 2 types:

  • primary
  • note
  • tip

These shortcodes look like this respectively:

primary: Here is a primary callout

note: Here is a note callout

tip: Here is a tip callout

Example code:

{{< secondaryCallout type="tip" >}}
  Here is a tip callout
{{< /secondaryCallout >}}

Provider Callout

A Provider callout can easily be added by using the providerCallout shortcode.

A providerCallout looks like this:

We're on Github!

A providerCallout with a link:

The provider is open source and available at the Raygun4JS repository.

Example code:

{{< providerCallout >}}
  We're on Github!
{{< /providerCallout >}}

Example code(with link):

{{< providerCallout >}}
  The provider is open source and available at the <a href=”https://github.com/MindscapeHQ/raygun4js”>Raygun4JS repository</a>.
{{< /providerCallout >}}

Heading shortcodes

The heading shortcodes enable you to specify a specific type of heading element but you can apply alternative heading styles to it.

An example use case for this would be if you wanted to add a heading one (H1) to the page but ensure it doesn’t get added to the table of contents. It would enable to you add a H2 element (this doens’t get added) then applies the .h1 styles.

The following shortcodes are available:

  • h1
  • h2
  • h3

The following classes are available:

  • h1
  • h2
  • h3
  • p

A h3 shortcode with the .h2 style applied looks like this:

Heading three with H2 style

Example code:

{{< h3 class="h2" >}}Heading three with H2 style{{< /h3 >}}

Choose your Language

A Choose your language shortcode can easily add the language & framework selection component to your page.

A chooseYourLanguage shortcode looks like this:

Example code:

{{< chooseyourlanguage >}}

Content row

NOTE: The spacing and alignment of text is important with this shortcode

Display an image to the left of a body of text content

Raygun Sidekick

Raygun Sidekick - dSYM uploader Mac OS X app

The Raygun Sidekick is a Mac OS X application that sits in your Mac menu bar which will detect, zip and upload the appropriate dSYM file in just a few clicks. It is highly recommend that you use the Raygun Sidekick rather than tediously uploading the dSYM files yourself as described below.

Download the Raygun Sidekick right here and check out the documentation for more info.

Code snippet

{{% contentRow %}}{{% contentRowColumn image="true" %}}![Raygun Sidekick](/documentation/upload/RaygunSidekick/Images/raygun-sidekick.png){{% /contentRowColumn %}}
  {{% contentRowColumn %}}#### Raygun Sidekick - dSYM uploader Mac OS X app

The Raygun Sidekick is a Mac OS X application that sits in your Mac menu bar which will detect, zip and upload the appropriate dSYM file in just a few clicks. It is highly recommend that you use the Raygun Sidekick rather than tediously uploading the dSYM files yourself as described below.

[Download the Raygun Sidekick right here](https://raygun.io/upload/RaygunSidekick/Raygun%20Sidekick.dmg) and check out the [documentation](/documentation/workflow/raygun-sidekick) for more info.{{% /contentRowColumn %}}{{% /contentRow %}}

Display an image to the right of a body of text content

Raygun Sidekick - dSYM uploader Mac OS X app

The Raygun Sidekick is a Mac OS X application that sits in your Mac menu bar which will detect, zip and upload the appropriate dSYM file in just a few clicks. It is highly recommend that you use the Raygun Sidekick rather than tediously uploading the dSYM files yourself as described below.

Download the Raygun Sidekick right here and check out the documentation for more info.

Raygun Sidekick

Code snippet

{{% contentRow %}}
  {{% contentRowColumn %}}#### Raygun Sidekick - dSYM uploader Mac OS X app

The Raygun Sidekick is a Mac OS X application that sits in your Mac menu bar which will detect, zip and upload the appropriate dSYM file in just a few clicks. It is highly recommend that you use the Raygun Sidekick rather than tediously uploading the dSYM files yourself as described below.

[Download the Raygun Sidekick right here](https://raygun.io/upload/RaygunSidekick/Raygun%20Sidekick.dmg) and check out the [documentation](/documentation/workflow/raygun-sidekick) for more info.{{% /contentRowColumn %}}
  {{% contentRowColumn image="true" %}}![Raygun Sidekick](/documentation/upload/RaygunSidekick/Images/raygun-sidekick.png){{% /contentRowColumn %}}
{{% /contentRow %}}