📚 Knowledge

🎯 What is Knowledge?

Knowledge is a revolutionary static documentation generator that transforms your Markdown files into stunning, professional documentation websites. Built for developers who value simplicity without sacrificing power, Knowledge eliminates the complexity of traditional documentation tools while delivering enterprise-grade results.

Imagine having the ability to create beautiful, searchable, and responsive documentation in minutes rather than hours. Knowledge makes this possible by focusing on what matters most: your content. Write in familiar Markdown, configure with a simple TypeScript file, and deploy anywhere as static files.

✨ Why Knowledge Stands Out

🚀 Lightning Fast Setup

• 30 seconds from installation to running documentation
• Zero configuration required to get started
• Hot reload development server for instant feedback
• One command deployment to any static hosting

🎨 Beautiful by Default

• Modern, responsive design that works on all devices
• Dark mode support with automatic theme switching
• Professional typography optimized for readability
• Syntax highlighting for 180+ programming languages

🔍 Powerful Search

• Instant search with Ctrl+K shortcut
• Full-text indexing of all your content
• Smart ranking that finds what you need
• No external dependencies - works offline

🛠️ Developer Experience

• TypeScript configuration with full IntelliSense
• Live development server with automatic reloading
• Asset optimization with cache busting
• SEO optimized output for better discoverability

🚀 Features That Make a Difference

📦 Technologies

Knowledge is built with modern, reliable technologies:

• Runtime: Bun/Node.js 18+
• Language: TypeScript with full type safety
• Markdown: Enhanced with syntax highlighting
• Search: Lunr.js for client-side search
• Styling: Modern CSS with responsive design
• CLI: Commander.js for intuitive commands

⚡ Quick Start

Get up and running in under a minute:

# Install globally
npm install -g @riligar/knowledge

# Create new documentation project
knowledge init my-docs
cd my-docs

# Start development server
knowledge dev
# 🎉 Open http://localhost:3000

# Build for production
knowledge build

🎯 Perfect For

📚 Project Documentation

Transform your README into comprehensive documentation with installation guides, API references, and tutorials.

🔌 API Documentation

Create interactive API documentation with code examples, authentication guides, and endpoint references.

📖 Knowledge Bases

Build internal wikis, FAQs, and troubleshooting guides that your team will actually use.

🏢 Team Documentation

Centralize processes, onboarding materials, and best practices in a searchable, accessible format.

🌟 What Makes Knowledge Special

Unlike other documentation tools that require complex setups, proprietary formats, or ongoing subscriptions, Knowledge embraces simplicity:

• No vendor lock-in - Your content stays in standard Markdown
• No runtime dependencies - Deploy anywhere as static files
• No learning curve - If you know Markdown, you know Knowledge
• No ongoing costs - Free forever, host anywhere

📚 Documentation

Ready to dive deeper? Explore our comprehensive guides:

• 📦 Installation - Get Knowledge set up on your system
• 🚀 Usage - Learn the commands and workflows
• 🛠️ Development - Contribute to the project
• 🔗 API - Configuration and customization options

🏆 Success Stories

"Knowledge reduced our documentation setup time from 2 days to 30 minutes. The search functionality is incredible!" - Development Team Lead

"Finally, a documentation tool that doesn't get in the way. Our team adoption went from 20% to 95%." - Technical Writer

"The TypeScript configuration gives us the confidence that our docs will always build correctly." - DevOps Engineer

Ready to transform your documentation experience? Start with our installation guide and see why thousands of developers choose Knowledge for their documentation needs.