Welcome to Verdocs

Verdocs is a high-performance, opinionated & version-aware documentation generator CLI built in Rust. It's designed to help you create searchable, and versioned documentation for your projects with minimal effort.

Core Philosophy

The goal of verdocs is to be a documentation tool that is:

• High Performance: Leverages Rust's capabilities for instant builds and fast site navigation.
• Versioning as First-Class: Documentation is treated as a continuous history. Versioning is a native feature, not an afterthought.
• Integrated Search: Search functionality is built-in and optimized for static sites without the need for external services.

Key Features

1. Markdown Native: Full support for standard and extended Markdown syntax.
2. Live Development Server: Preview changes in real-time with an integrated development server.
3. Local Search Index: High-speed search across all documentation versions via a client-side index.
4. Automated Navigation: Dynamic sidebar and navigation generation derived from your directory structure.
5. Fully Responsive: Modern, adaptive layout that looks great on mobile, tablet, and desktop screens.