Code Block

Adding code blocks to your docs

config.js
import createMDX from 'fumadocs-mdx/config';

const withMDX = createMDX();

/** @type {import('next').NextConfig} */
const config = {
  reactStrictMode: true, 
};

export default withMDX(config);

Display code blocks, required by default.

  • Syntax highlighting powered by Shiki
  • Copy button
  • Custom titles and icons

Usage

Wrap the pre element in <CodeBlock />, which acts as the wrapper of code block.

import { Pre, CodeBlock } from 'fumadocs-ui/components/codeblock';

<MDX
  components={{
    pre: ({ ref: _ref, title, ...props }) => (
      <CodeBlock title={title}>
        <Pre {...props} />
      </CodeBlock>
    ),
  }}
/>

Highlight Lines

You spectify highlighted lines by adding [!code highlight].

```tsx
<div>Hello World</div>  // [!code highlight]
<div>Hello World</div>
<div>Goodbye</div>
<div>Hello World</div>
```

Highlight Words

You can highlight a specific word by adding [!code word:<match>].

```js
// [!code word:config]
const config = {
  reactStrictMode: true,
};
```

Title

Add title="x" to the codeblock meta.

```js title="next.config.js"
console.log('Hello World');
```

Icons

You can specify a custom icon by passing an icon prop to CodeBlock component.

When the icon prop is passed as a string, it will be parsed as JSON and converted into CodeBlockIcon.

config.js
console.log('js');
config.ts
console.log('ts');
document.md
# Hello World!
document.mdx
# Hello World!
main.rs
fn main() {
    println!("Hello World!");
}
component.tsx
<MDXContent>Hello World</MDXContent>
style.css
.nd-codeblock {
  color: red;
}

Last updated on