huyikai / vitepress-helper

enhance vitepress experience

VitePress-Helper

English | 简体中文

Introduction

Optimized user experience based on vitepress.

Features

• CLI: Guide to complete the initialization operation.
• Nav: Automatically generate the navigation bar according to the file directory.
• Sidebar: Automatically generate the sidebar according to the file directory.
• CMS: Run local CMS to simplify content management.
• Homepage: Customizable homepage.
• Internationalization: Automatically generate corresponding navigation bar and sidebar according to internationalization configuration.

Usage

npx @huyikai/vitepress-helper init

For detailed usage, please refer to the vitepress-helper documentation for operation.

Short-term Plan

• Documentation: More detailed usage instructions, appropriate usage examples.
• CMS：
  • Optimize the user experience of the Markdown editor.
  • File and directory movement and drag-and-drop movement.
  • Local file import, batch processing.
  • Link content import.
  • Version control.
  • Static resource (image) management.

Long-term Plan

• Testing: Increase unit tests to ensure code quality.
• Experience: Optimize UI, usage logic, performance optimization.
• Maintenance: Pay attention to the updates of vitepress, keep the functions and experience synchronized.
• Exploration: Plan for new inspirations during the development and usage process.