Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

vuepress-plugin-global-toc

1.0.1 • Public • Published

vuepress-plugin-global-toc

NPM version NPM downloads

This plugin requires VuePress >= 1.0.0.

Features

  • Add a <GlobalTableOfContents /> component that you can use in your markdown instead of [[toc]] to get a global Table of Contents, i.e. a table of contents that covers the entire vuepress website.
  • Internally uses the same function that retrieves the items in the sidebar

Install

npm i vuepress-plugin-global-toc

Usage

Using this plugin:

// .vuepress/config.js
module.exports = {
  plugins: ['vuepress-plugin-global-toc']
}

then add your table of components where you please in your markdown pages:

# Table of contents
 
<GlobalTableOfContents />

Keywords

Install

npm i vuepress-plugin-global-toc

DownloadsWeekly Downloads

91

Version

1.0.1

License

MIT

Unpacked Size

3.91 kB

Total Files

7

Last publish

Collaborators

  • avatar