{"id":13449487,"url":"https://github.com/jooy2/vitepress-sidebar","last_synced_at":"2025-04-06T09:07:40.990Z","repository":{"id":62002975,"uuid":"557015234","full_name":"jooy2/vitepress-sidebar","owner":"jooy2","description":"🔌 VitePress Sidebar is a plugin for VitePress that automatically configures and manages the sidebar of your page with simple settings.","archived":false,"fork":false,"pushed_at":"2024-05-29T00:28:31.000Z","size":1643,"stargazers_count":113,"open_issues_count":8,"forks_count":8,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-05-29T14:33:10.086Z","etag":null,"topics":["automation","generator","menu","menus","plugin","sidebar","sidebar-menu","vite","vitepress","vitepress-plugin","vitepress-plugin-sidebar","vitepress-theme"],"latest_commit_sha":null,"homepage":"https://vitepress-sidebar.jooy2.com","language":"TypeScript","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/jooy2.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"jooy2","custom":["https://jooy2.com/donate"]}},"created_at":"2022-10-24T23:50:33.000Z","updated_at":"2024-06-19T00:08:44.281Z","dependencies_parsed_at":"2024-04-19T10:27:56.795Z","dependency_job_id":"0ae898d0-5537-41bb-b840-409520dfde02","html_url":"https://github.com/jooy2/vitepress-sidebar","commit_stats":{"total_commits":100,"total_committers":2,"mean_commits":50.0,"dds":"0.19999999999999996","last_synced_commit":"0ca4dae38195b06196342ca5b9c2da159df6c3f9"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jooy2%2Fvitepress-sidebar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jooy2%2Fvitepress-sidebar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jooy2%2Fvitepress-sidebar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jooy2%2Fvitepress-sidebar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jooy2","download_url":"https://codeload.github.com/jooy2/vitepress-sidebar/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247457801,"owners_count":20941906,"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":["automation","generator","menu","menus","plugin","sidebar","sidebar-menu","vite","vitepress","vitepress-plugin","vitepress-plugin-sidebar","vitepress-theme"],"created_at":"2024-07-31T06:00:40.130Z","updated_at":"2025-04-06T09:07:40.806Z","avatar_url":"https://github.com/jooy2.png","language":"TypeScript","funding_links":["https://github.com/sponsors/jooy2","https://jooy2.com/donate"],"categories":[":electric_plug: Plugins","Plugins"],"sub_categories":["Community Plugins"],"readme":"# 🔌 VitePress Sidebar\n\n[![awesome-vitepress](https://awesome.re/mentioned-badge.svg)](https://github.com/logicspark/awesome-vitepress-v1) [![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/jooy2/vitepress-sidebar/blob/master/LICENSE) ![Programming Language Usage](https://img.shields.io/github/languages/top/jooy2/vitepress-sidebar) ![Commit Count](https://img.shields.io/github/commit-activity/y/jooy2/vitepress-sidebar) [![npm downloads](https://img.shields.io/npm/dm/vitepress-sidebar.svg)](https://www.npmjs.com/package/vitepress-sidebar) [![npm latest package](https://img.shields.io/npm/v/vitepress-sidebar/latest.svg)](https://www.npmjs.com/package/vitepress-sidebar) ![npm bundle size](https://img.shields.io/bundlephobia/min/vitepress-sidebar) [![Followers](https://img.shields.io/github/followers/jooy2?style=social)](https://github.com/jooy2) ![Stars](https://img.shields.io/github/stars/jooy2/vitepress-sidebar?style=social)\n\n**VitePress Sidebar** is a plugin for **[VitePress](https://vitepress.dev)** that automatically configures and manages the sidebar of your page with simple settings.\n\n- ⚡️ Optimized for the latest version of **VitePress**\n- ⚡️ Easy to use, lots of options to customize to your liking\n- ⚡️ Lightweight bundle file size\n- ⚡️ [Multiple Sidebars](https://vitepress.dev/reference/default-theme-sidebar#multiple-sidebars) support\n- ⚡️ [Frontmatter](https://vitepress.dev/guide/frontmatter) support\n- ⚡️ [TypeScript](https://www.typescriptlang.org) support\n- ⚡️ Customize menus for sorting, special character conversion, file and folder filters, and more!\n\n## [Documentation (Getting Started \u0026 All option lists)](https://vitepress-sidebar.cdget.com/guide/getting-started)\n\nInstalling and using the package and defining all the utility methods can be found on the documentation page below: https://vitepress-sidebar.cdget.com/guide/getting-started\n\n```javascript\nimport { withSidebar } from 'vitepress-sidebar';\n\nconst vitePressConfigs = {\n  title: 'VitePress Sidebar',\n  themeConfig: {\n    // ...\n  }\n};\n\nexport default defineConfig(\n  withSidebar(vitePressConfigs, {\n    /*\n     * For detailed instructions, see the links below:\n     * https://vitepress-sidebar.cdget.com/guide/options\n     */\n    //\n    // ============ [ RESOLVING PATHS ] ============\n    // documentRootPath: '/',\n    // scanStartPath: null,\n    // resolvePath: null,\n    // basePath: null,\n    //\n    // ============ [ GROUPING ] ============\n    // collapsed: true,\n    // collapseDepth: 2,\n    // rootGroupText: 'Contents',\n    // rootGroupLink: 'https://github.com/jooy2',\n    // rootGroupCollapsed: false,\n    //\n    // ============ [ GETTING MENU TITLE ] ============\n    // useTitleFromFileHeading: true,\n    // useTitleFromFrontmatter: true,\n    // useFolderLinkFromIndexFile: false,\n    // useFolderTitleFromIndexFile: false,\n    // frontmatterTitleFieldName: 'title',\n    //\n    // ============ [ GETTING MENU LINK ] ============\n    // useFolderLinkFromSameNameSubFile: false,\n    // useFolderLinkFromIndexFile: false,\n    // folderLinkNotIncludesFileName: false,\n    //\n    // ============ [ INCLUDE / EXCLUDE ] ============\n    // excludePattern: ['README.md', 'folder/'],\n    // excludeFilesByFrontmatterFieldName: 'exclude',\n    // includeDotFiles: false,\n    // includeEmptyFolder: false,\n    // includeRootIndexFile: false,\n    // includeFolderIndexFile: false,\n    //\n    // ============ [ STYLING MENU TITLE ] ============\n    // hyphenToSpace: true,\n    // underscoreToSpace: true,\n    // capitalizeFirst: false,\n    // capitalizeEachWords: false,\n    // keepMarkdownSyntaxFromTitle: false,\n    // removePrefixAfterOrdering: false,\n    // prefixSeparator: '.',\n    //\n    // ============ [ SORTING ] ============\n    // manualSortFileNameByPriority: ['first.md', 'second', 'third.md'],\n    // sortFolderTo: null,\n    // sortMenusByName: false,\n    // sortMenusByFileDatePrefix: false,\n    // sortMenusByFrontmatterOrder: false,\n    // frontmatterOrderDefaultValue: 0,\n    // sortMenusByFrontmatterDate: false,\n    // sortMenusOrderByDescending: false,\n    // sortMenusOrderNumericallyFromTitle: false,\n    // sortMenusOrderNumericallyFromLink: false,\n    //\n    // ============ [ MISC ] ============\n    // debugPrint: false,\n  })\n);\n```\n\n## Real-world Uses\n\n**VitePress Sidebar** is utilized in a variety of project environments, including my own web services.\n\n- To explore packages used other than: https://github.com/jooy2/vitepress-sidebar/network/dependents\n\n## Contribute\n\nYou can report issues on [GitHub Issue Tracker](https://github.com/jooy2/vitepress-sidebar/issues).\n\nYou can also request a pull to fix bugs and add frequently used features. To contribute to a project, follow these steps\n\n1. Clone the project.\n2. Create changes (features, bugfixes) in a new branch.\n3. Write a test (`test/specs/options.test.ts`) if a new option has been added.\n4. Create a documentation (`docs/`) if a new option is added.\n5. Request a pull request. Include any changes or considerations in the description for a quick code review.\n\n## License\n\nCopyright © 2022-2024 [CDGet](https://cdget.com) \u003c[jooy2.contact@gmail.com](mailto:jooy2.contact@gmail.com)\u003e Released under the MIT license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjooy2%2Fvitepress-sidebar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjooy2%2Fvitepress-sidebar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjooy2%2Fvitepress-sidebar/lists"}