Table of Contents

Usage

It extracts the headings of a MDX document to vfile.data.toc. You may write your own plugin to convert it into a MDX export.

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

export default {
  remarkPlugins: [remarkHeading],
};

If your heading doesn't have an id, it will add one automatically.

Output

An array of TOCItemType.

TOCItemType