Skip to main contentGatsby theme Carbon

Code blocks

When authoring markdown using the Carbon Gatsby theme, code blocks have some extra super powers you can take advantage of. We provide carbon-themed syntax highlighting as well as optional

path
,
src
and
hideCode
features.

Example

Horizontal overflow
## Path and src w/ overflow
This example overflows to demonstrate the text fading out under the side bar.
This example overflows to demonstrate the text fading out under the side bar.
This example overflows to demonstrate the text fading out under the side bar.
This example overflows to demonstrate the text fading out under the side bar.
Vertical overflow
## Path, src, hideCode w/ overflow
This example demonstrates the show more button. This example demonstrates the
show more button. This example demonstrates the show more button. This example
demonstrates the show more button. This example demonstrates the show more
button. This example demonstrates the show more button. This example
demonstrates the show more button. This example demonstrates the show more
button. This example demonstrates the show more button. This example
demonstrates the show more button. This example demonstrates the show more
button. This example demonstrates the show more button. This example demonstrates the show more button.
This example demonstrates the show more button. This example demonstrates the show more button.
This example demonstrates the show more button. This example demonstrates the show more button.

Code

```markdown path=/directory/file.mdx src=https://gatsby.carbondesignsystem.com hideCode=true
### Path, src and hideCode
This code snippet provides a `path`, a `src` and `hideCode` prop.
```

Props

propertypropTypedescription
languagestringAvailable languages.
srcstringThe full url of a relevant link (source)
pathstringA string indicating the filename or path. Due to markdown limitations this can only be a single word
hideCodebooleanA boolean indicating if the code block should have a Show More button. Code block should have more than 9 lines to display the button. Default value =
false