🔌 VitePress Sidebar

VitePress Sidebar is a plugin for VitePress that automatically configures and manages the sidebar of your page with simple settings.

• ⚡️ Optimized for the latest version of VitePress
• ⚡️ Easy to use, lots of options to customize to your liking
• ⚡️ Lightweight bundle file size
• ⚡️ Multiple Sidebars support
• ⚡️ Frontmatter support
• ⚡️ TypeScript support
• ⚡️ Customize menus for sorting, special character conversion, file and folder filters, and more!

Documentation (Getting Started & All option lists)

Installing 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

1import { withSidebar } from 'vitepress-sidebar';
2
3const vitePressConfigs = {
4  title: 'VitePress Sidebar',
5  themeConfig: {
6    // ...
7  }
8};
9
10export default defineConfig(
11  withSidebar(vitePressConfigs, {
12    /*
13     * For detailed instructions, see the links below:
14     * https://vitepress-sidebar.cdget.com/guide/options
15     */
16    //
17    // ============ [ RESOLVING PATHS ] ============
18    // documentRootPath: '/',
19    // scanStartPath: null,
20    // resolvePath: null,
21    // basePath: null,
22    //
23    // ============ [ GROUPING ] ============
24    // collapsed: true,
25    // collapseDepth: 2,
26    // rootGroupText: 'Contents',
27    // rootGroupLink: 'https://github.com/jooy2',
28    // rootGroupCollapsed: false,
29    //
30    // ============ [ GETTING MENU TITLE ] ============
31    // useTitleFromFileHeading: true,
32    // useTitleFromFrontmatter: true,
33    // useFolderLinkFromIndexFile: false,
34    // useFolderTitleFromIndexFile: false,
35    // frontmatterTitleFieldName: 'title',
36    //
37    // ============ [ GETTING MENU LINK ] ============
38    // useFolderLinkFromSameNameSubFile: false,
39    // useFolderLinkFromIndexFile: false,
40    // folderLinkNotIncludesFileName: false,
41    //
42    // ============ [ INCLUDE / EXCLUDE ] ============
43    // excludePattern: ['README.md', 'folder/'],
44    // excludeFilesByFrontmatterFieldName: 'exclude',
45    // includeDotFiles: false,
46    // includeEmptyFolder: false,
47    // includeRootIndexFile: false,
48    // includeFolderIndexFile: false,
49    //
50    // ============ [ STYLING MENU TITLE ] ============
51    // hyphenToSpace: true,
52    // underscoreToSpace: true,
53    // capitalizeFirst: false,
54    // capitalizeEachWords: false,
55    // keepMarkdownSyntaxFromTitle: false,
56    // removePrefixAfterOrdering: false,
57    // prefixSeparator: '.',
58    //
59    // ============ [ SORTING ] ============
60    // manualSortFileNameByPriority: ['first.md', 'second', 'third.md'],
61    // sortFolderTo: null,
62    // sortMenusByName: false,
63    // sortMenusByFileDatePrefix: false,
64    // sortMenusByFrontmatterOrder: false,
65    // frontmatterOrderDefaultValue: 0,
66    // sortMenusByFrontmatterDate: false,
67    // sortMenusOrderByDescending: false,
68    // sortMenusOrderNumericallyFromTitle: false,
69    // sortMenusOrderNumericallyFromLink: false,
70    //
71    // ============ [ MISC ] ============
72    // debugPrint: false,
73  })
74);

Real-world Uses

VitePress Sidebar is utilized in a variety of project environments, including my own web services.

• To explore packages used other than: https://github.com/jooy2/vitepress-sidebar/network/dependents

Contributing

Anyone can contribute to the project by reporting new issues or submitting a pull request. For more information, please see CONTRIBUTING.md.

License

Please see the LICENSE file for more information about project owners, usage rights, and more.