vuepress-plugin-global-toc
v1.1.0
Published
Vuepress plugin to add a global Table of Contents component
Downloads
50
Readme
vuepress-plugin-global-toc
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 />