Vitepress Knowledge

Overview

VitePress Knowledge is an innovative solution designed to enhance your VitePress website by adding a self-hosted LLM (Language Learning Model) chatbot. This smart assistant is uniquely trained on your documentation, providing users with an interactive way to access information. With a straightforward setup process, you can seamlessly integrate an AI-driven chat feature into your site, creating a more engaging user experience.

Setting up the VitePress Knowledge chatbot is simple and efficient, requiring just a couple of steps. You'll generate knowledge files from your existing markdown documentation and self-host a lightweight server to manage chat interactions. Whether you're looking to assist users on your site or streamline access to documentation, this tool is a valuable addition.

Features

• Easy Installation: Simply add the vitepress-knowledge NPM package to your project, making the integration hassle-free.
• Custom Knowledge Files: Generate knowledge files that consolidate your markdown docs, ensuring the chatbot is well-informed about your software.
• User-Friendly Chat Interface: Integrate an "Ask AI" button and a chat window directly into your website, enhancing user engagement.
• API Key Security: The backend manages requests to Google/Anthropic, allowing you to keep your API keys secure without exposing them on your site.
• Flexible Deployment: Use a provided Docker Compose file to quickly set up the backend server, streamlining the deployment process.
• Advanced Configuration Options: Explore plugin and server documentation for more detailed customization and advanced features to suit your specific needs.