vuepress-simple-sidebar

A simple sidebar that automatically generates level 1 links of your documentation files

Usage no npm install needed!

<script type="module">
  import vuepressSimpleSidebar from 'https://cdn.skypack.dev/vuepress-simple-sidebar';
</script>

README

Vuepress simple sidebar plugin

A simple and minimal-configuration automatic sidebar navigation generator plugin. Focus on your documents, not the tooling.

Demo

The documentation of this project can provide a nice demo, check it out here.

Alternatively, you can build and view the documentation locally by running

npm run docs:dev

and then visit localhost:8080.

Installation

npm install vuepress-simple-sidebar

Usage

In your .vuepress/config.js add the plugin to the plugins property as:

plugins: [
    ...
    'vuepress-simple-sidebar',
]

Development

Please find the development documentation in the docs folder.

Contributing

Please create a ticket if you encounter a bug.