JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 8
  • Score
    100M100P100Q39331F

A package used for generating a sidemenu based on the file structure

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (vuepress-automenu) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    Vuepress auto-menu

    npm npm GitHub issues GitHub stars GitHub license

    A package which gives you the option to automatically generate the side and nav menu structure based on your filestructure. The sidebar will be based on folder names and file names and the nav menu will only use folder names.

    Installation:

    NPM:

    npm i vuepress-automenu

    Yarn:

    yarn i vuepress-automenu

    Usage:

    You use the getSidebarItems() or getNavbarItems() functions, depending on which one you need to get all the menu items. It uses {projectfolder}/docs as default location but you can change it by adding your folder as parameter to either of the functions. (like this: src)

    import { getSidebarItems, getNavbarItems } from 'vuepress-automenu';
    
    export default defineUserConfig({
        theme: defaultTheme({
            navbar: getNavbarItems(),
            sidebar: getSidebarItems()
        }),
    })

    Collaboration:

    If you want to report bugs, propose features or view what I'm working on you can use the Github link below.

    https://github.com/Alphaegen/vuepress-automenu