@minipx/gatsby-remark-toc
<p align="center"> <a href="https://next.gatsbyjs.org"> <img alt="Gatsby" src="https://www.gatsbyjs.org/monogram.svg" width="60" /> </a> </p> <h1 align="center"> gatsby-remark-toc </h1>
Last updated a year ago by crossjs .
MIT · Original npm · Tarball · package.json
$ cnpm install @minipx/gatsby-remark-toc 
SYNC missed versions from official npm registry.

Gatsby

gatsby-remark-toc

⚛️ ???? :rocket:

Adds a table of contents to Markdown files using mdast-util-toc

Current TravisCI build status. Current npm package version. Downloads per month on npm.

???? Install

npm install gatsby-remark-toc --save

???? How to use

// in your gatsby-config.js
plugins: [
  {
    resolve: 'gatsby-transformer-remark',
    options: {
      plugins: [
        {
          resolve: 'gatsby-remark-toc',
          options: {
            header: 'Table of Contents', // the custom header text
            include: [
              'content/**/*.md' // an include glob to match against
            ]
          }
        }
      ]
    }
  }
];

additionally, you can pass custom options directly to mdast-util-toc like so:

// in your gatsby-config.js
plugins: [
  {
    resolve: 'gatsby-transformer-remark',
    options: {
      plugins: [
        {
          resolve: 'gatsby-remark-toc',
          options: {
            header: 'Table of Contents', // the custom header text
            include: [
              'content/**/*.md' // an include glob to match against
            ],
            mdastUtilTocOptions: {
              maxDepth: 2
            }
          }
        }
      ]
    }
  }
];

Current Tags

  • 1.1.0                                ...           latest (a year ago)

1 Versions

  • 1.1.0                                ...           a year ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 1
Dependencies (2)
Dev Dependencies (9)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |