vuepress-plugin-autonav
v0.1.3
Published
Auto nav links plugin for VuePress 1.x
Downloads
9
Maintainers
Readme
VuePress Plugin Auto Nav Links
Auto nav links plugin for VuePress 1.x
What
Auto populates themeConfig.nav
with top level pages if it's not already set.
Using a page frontmatter
you can:
- Enable/disable adding a link to the navbar - a typical would be if you don't want to add the home page
- Page order
Install
$ npm install -D vuepress-plugin-autonav
# or
$ yarn add -D vuepress-plugin-autonav
Usage
Add vuepress-plugin-autonav
in your site or theme config file.
// .vuepress/config.js
// or
// .vuepress/theme/index.js
// set your global autonav options - override in page frontmatter `autonav`
const autonav_options = {
enable: true
};
module.exports = {
plugins: [
[ 'autonav', autonav_options ]
]
}
Page frontmatter
---
title: Page Title
autonav:
enable: true
order: -1
---
Reference
- VuePress official plugin docs
- VuePress official Navbar Links
- VuePress official Front Matter
Related Plugins
License
MIT © webmasterish