Documentation Components

This documentation uses gatsby with MDX. For MDX there are custom components / plugins added which differ from regular MDX setups. To see how they are used have a look at the source of this page.

Code Tabs

Sibling code blocks are automatically merged into a block with tabs to switch between them. To prevent two adjacent code blocks to merge separate them with the <Break/> component.

Example of two code blocks merged:

Copied
import * as Sentry from "sentry-browser";
Sentry.init("");
// id: 
// org-slug: 
// slug: 

A second example with three code blocks that have file names set:

hello.c
Copied
#include <stdio.h>

int main() {
    printf("Hello World\n");
}

Another code block with different languages for comparison:

hello.html
Copied
<h1>Hello World</h1>

Two JavaScript variants where one has an explicit title override:

Copied
Sentry.init();

Code without title:

Copied
nolang all alone

no lang

Copied

```python 
print "Python"

Three code blocks, where the second forced a break from the first (<Break/>):

Copied
print "I am block 1"
Copied
print "I am block 2"

Example usage in a nested structure:

  1. Creation of the SDK (sometimes this is hidden from the user):

    Copied
    Sentry.init({dsn: ''});
Copied
echo "Some code outside"

If two blocks share the same language and get merged, they get enumerated:

Copied
I am block 1
You can edit this page on GitHub.
On this page