Giter VIP home page Giter VIP logo

markdown-toc's Introduction

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

Name Type Description Default
parser Function function to convert markdown to html null, required
slugify Function slug function s => s
space Number number of spaces 2

Examples

Others

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

markdown-toc's People

Contributors

shuoshubao avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.