{"id":13832483,"url":"https://github.com/webmasterish/vuepress-plugin-autonav","last_synced_at":"2025-04-13T13:33:24.861Z","repository":{"id":65519612,"uuid":"164004747","full_name":"webmasterish/vuepress-plugin-autonav","owner":"webmasterish","description":"Auto nav links plugin for VuePress 1.x","archived":false,"fork":false,"pushed_at":"2019-08-08T20:27:16.000Z","size":14,"stargazers_count":12,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-27T04:34:12.886Z","etag":null,"topics":["links","menu","nav","nav-links","vue","vuepress","vuepress-plugin"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/webmasterish.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-01-03T17:45:39.000Z","updated_at":"2022-05-13T13:52:55.000Z","dependencies_parsed_at":"2023-01-27T02:10:22.838Z","dependency_job_id":null,"html_url":"https://github.com/webmasterish/vuepress-plugin-autonav","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webmasterish%2Fvuepress-plugin-autonav","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webmasterish%2Fvuepress-plugin-autonav/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webmasterish%2Fvuepress-plugin-autonav/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webmasterish%2Fvuepress-plugin-autonav/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/webmasterish","download_url":"https://codeload.github.com/webmasterish/vuepress-plugin-autonav/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248721596,"owners_count":21151124,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["links","menu","nav","nav-links","vue","vuepress","vuepress-plugin"],"created_at":"2024-08-04T11:00:19.185Z","updated_at":"2025-04-13T13:33:24.842Z","avatar_url":"https://github.com/webmasterish.png","language":"JavaScript","funding_links":[],"categories":["Plugins"],"sub_categories":["Community"],"readme":"# VuePress Plugin Auto Nav Links\n\n\u003e Auto nav links plugin for VuePress 1.x\n\n[![Build Status](https://img.shields.io/travis/webmasterish/vuepress-plugin-autonav/master.svg?style=flat-square)](https://travis-ci.org/webmasterish/vuepress-plugin-autonav)\n[![npm version](https://img.shields.io/npm/v/vuepress-plugin-autonav.svg?style=flat-square)](http://npm.im/vuepress-plugin-autonav)\n[![Greenkeeper badge](https://badges.greenkeeper.io/webmasterish/vuepress-plugin-autonav.svg?style=flat-square)](https://greenkeeper.io/)\n[![MIT License](https://img.shields.io/npm/l/express.svg?style=flat-square)](http://opensource.org/licenses/MIT)\n\n\n## What\n\nAuto populates `themeConfig.nav` with top level pages if it's not already set.\n\nUsing a page `frontmatter` you can:\n\n- Enable/disable adding a link to the navbar - a typical would be if you don't\n  want to add the home page\n- Page order\n\n\n## Install\n\n\n```sh\n$ npm install -D vuepress-plugin-autonav\n\n# or\n\n$ yarn add -D vuepress-plugin-autonav\n```\n\n\n## Usage\n\nAdd `vuepress-plugin-autonav` in your site or theme config file.\n\n\u003e See [official docs on using a plugin](https://vuepress.vuejs.org/plugin/using-a-plugin.html)\n\n\n```js\n// .vuepress/config.js\n// or\n// .vuepress/theme/index.js\n\n// set your global autonav options - override in page frontmatter `autonav`\nconst autonav_options = {\n  enable: true\n};\n\nmodule.exports = {\n  plugins: [\n    [ 'autonav', autonav_options ]\n  ]\n}\n```\n\n\n### Page `frontmatter`\n\n\n```md\n---\n\ntitle: Page Title\n\nautonav:\n  enable: true\n  order: -1\n\n---\n\n```\n\n\n## Reference\n\n- VuePress official [plugin docs](https://vuepress.vuejs.org/plugin/)\n- VuePress official [Navbar Links](https://vuepress.vuejs.org/theme/default-theme-config.html#navbar-links)\n- VuePress official [Front Matter](https://vuepress.vuejs.org/guide/frontmatter.html)\n\n\n## Related Plugins\n\n- [VuePress Plugin Auto Meta](https://github.com/webmasterish/vuepress-plugin-autometa)\n- [VuePress Plugin Minimal Google Analytics](https://github.com/webmasterish/vuepress-plugin-minimal-analytics)\n\n\n## License\n\nMIT © [webmasterish](https://webmasterish.com)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebmasterish%2Fvuepress-plugin-autonav","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwebmasterish%2Fvuepress-plugin-autonav","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebmasterish%2Fvuepress-plugin-autonav/lists"}