Docs

Structurize

Extract information from your documents

Usage

Accepts MDX/markdown content and return structurized data. Useful for implementing document search.

import { structure } from 'next-docs-zeta/mdx-plugins'
 
structure(page.body.raw)

Parameters

Parameter
`content`	MDX/markdown content
`remarkPlugins`	List of remark plugins
`options`	Custom options

Options

Option
`types`	Scanned element types (remark)

Output

A list of headings and contents. Paragraphs will be extracted to the contents array, each item contains a heading prop indicating the heading of paragraph.

Note: A heading can have multiple paragraphs.

Heading

Prop
`id`	unique identifer or slug of heading
`content`	Text content

Content

Prop
`heading`	Heading of paragraph (nullable)
`content`	Text content

Last updated on

Git Last Edit

MDX Plugins