1.2.0 • Published 1 year ago

mdx-toc v1.2.0

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

mdx-toc

Table of contents

Usage

import MarkdownIt from 'markdown-it'
import getTocData from 'mdx-toc'

const content = '<h1>title one</h1>'

// const tocData = getTocData(content, options)
const tocData = getTocData(content, {
  parser: md => MarkdownIt().render(md)
})

const {
  markdown = '',
  html = '',
  list = [],
  treeData: []
} = tocData

Options

NameTypeDescriptionDefault
parserFunctionfunction to convert markdown to htmlnull, required
slugifyFunctionslug functions => s
spaceNumbernumber of spaces2

Examples

Others

  • doctoc
  • markdown-it-toc
  • markdown-toc
  • markdown-it-table-of-contents