コンテンツへスキップ
Fumadocs

Rehype Code

コードのシンタックスハイライター

Fumadocs で使用されているシンタックスハイライター @shikijs/rehype のラッパーです。

加工前の <pre /> コードブロックを、ハイライト済みのコードブロックに変換します。

```ts
console.log('Hello World');
```

使い方

Rehype Code は rehype プラグインで、Fumadocs MDX ではデフォルトで有効になっています。オプションは rehypeCodeOptions で指定します。

source.config.ts
import { defineConfig } from 'fumadocs-mdx/config';

export default defineConfig({
  mdxOptions: {
    rehypeCodeOptions: {
      themes: {
        light: 'github-light',
        dark: 'github-dark',
      },
    },
  },
});

ハイライター

このプラグインは Shiki を使用します。rehypeCodeFromHighlighter は、Shiki の代わりに Highlights などの別のハイライターを受け取り、Shiki 以外のオプションを指定できます。プラグインのトランスフォーマーを使ってハイライターを作成する関数を渡してください。

デフォルトのプラグインを無効にして、こちらを追加します:

source.config.ts
import { defineConfig } from 'fumadocs-mdx/config';
import { rehypeCodeFromHighlighter } from 'fumadocs-core/mdx-plugins/rehype-code.core';
import { highlighter } from './lib/highlighter';

export default defineConfig({
  mdxOptions: {
    rehypeCodeOptions: false,
    rehypePlugins: [
      () =>
        rehypeCodeFromHighlighter(({ transformers }) =>
          highlighter.override({ shikiTransformers: transformers }),
        ),
    ],
  },
});

Meta

メタ文字列から title を解析し、pre 要素に属性として追加します。

```js title="Title"
console.log('Hello');
```

filterMetaString オプションを使用すると、処理前にメタ文字列をフィルタリングできます。

インラインコード

inline オプションを使うと有効にできます。

import { type RehypeCodeOptions } from 'fumadocs-core/mdx-plugins';

const rehypeCodeOptions: RehypeCodeOptions = {
  inline: 'tailing-curly-colon',
};
Syntax
これはハイライトされたインラインコードです: `console.log("hello world"){:js}`.

これはハイライトされたインラインコードです:console.log("hello world")。

アイコン

このプラグインは、言語のメタ文字列に応じて icon 属性を自動的に追加します。 この属性は HTML 文字列のため、React の dangerouslySetInnerHTML を使ってレンダリングできます。

```ts
console.log('This should shows the logo of TypeScript');
```

icon オプションで、アイコンを無効化またはカスタマイズできます。

未対応の言語

Shiki がサポートしていない言語のコードブロックがあると、ビルドが失敗します。代わりに別の言語としてハイライトするには、fallbackLanguage を設定します。

source.config.ts
import { defineConfig } from 'fumadocs-mdx/config';

export default defineConfig({
  mdxOptions: {
    rehypeCodeOptions: {
      fallbackLanguage: 'plaintext',
    },
  },
});

その他のオプション

オプションは Shiki から継承されています。そのほかのオプションについては、Shiki のドキュメントを参照してください。

How is this guide?