slam24 / react-auto-toc

react-auto-toc

⚠️I made a new package which serves the same purpose. Plese use react-toc instead.⚠️

Automatically create a table of contents.

Description

The idea is that you can automatically create a table of contents from your markdown text.

PRs/Issues are always welcome.

Install

npm install --save react-auto-toc

Usage

Pass your markdown content as a prop.

import React, { Component } from 'react'
import Toc from 'react-auto-toc'

class Example extends Component {
  render() {
    const content = '# test \n your markdown Content # test2\n'
    return <Toc markdownText={content} />
  }
}

Custom style

The list(ul) has a class called toc-list and each item(li) has header1, header2 or header3 as its class. Lastly, every title(a) has a class called toc-title.

You can add styles to them in your css files.

License

MIT © K-Sato1995