Core Concepts
Verdocs is an opinionated documentation generator designed for performance and ease of use. To achieve this, it employs a few unique "grammar" rules and a strict project structure that ensures consistency across different versions of your documentation.
Grammar and Structure
Unlike generic static site generators, Verdocs is specifically tuned for documentation. Its primary differentiators include:
- Strict Versioning: Documentation isn't just a collection of files; it's a versioned history. The folder structure itself defines the available versions of your site.
- Native Admonitions: Verdocs introduces a custom syntax for callouts (tips, warnings, etc.) that are rendered beautifully without external plugins.
- Intelligent Path Resolution: It handles complex relative and global linking strategies, making it easy to move files without breaking links or image references.
- Zero-Config Search: A client-side search index is automatically generated for every version, ensuring high-speed search functionality.
Documentation Sections
Explore the core features of Verdocs in detail:
| Section | Description |
|---|---|
| Project Requirements | Mandatory directory structure and file naming rules. |
| Admonitions | How to use and customize color-coded callouts. |
| Path Resolution | Understanding relative and global (@/) linking. |
| Versions | Naming conventions and managing multiple documentation versions. |