Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@riligar/documentation) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Documentation - Modern Documentation Generator

GitHub License

🎯 What is Documentation?

Documentation is a modern static documentation generator that transforms Markdown files into professional documentation sites. It's the perfect tool for anyone who wants to create beautiful and functional documentation without complications.

📊 Expected ROI

Time Saved

Before: 4-8 hours for basic documentation
After: 30-60 minutes with prompt
Savings: 85-90% of time

Improved Quality

Consistency: Standardized templates
Completeness: Coverage of all aspects
Usability: Modern and navigable interface

🚀 Features

Markdown-First: Write documentation in familiar Markdown syntax
Static Site Generation: Fast, secure, and SEO-friendly output
Modern Themes: Beautiful, responsive themes out of the box
Search Integration: Built-in search functionality
CLI Tool: Simple command-line interface for easy management
Live Development: Hot-reload during development

📦 Installation

# Global installation (recommended)
npm install -g @riligar/documentation

# Or with bun
bun add -g @riligar/documentation

# Or with yarn
yarn global add @riligar/documentation

# Or with pnpm
pnpm add -g @riligar/documentation

🎯 Quick Start

Initialize a new project:
```
documentation init my-docs
cd my-docs
```
Start development server:
```
documentation dev
```
Build for production:
```
documentation build
```

🎨 What you get automatically

Category	Features	Benefits
Professional Interface	• Modern and clean design • Automatic sidebar navigation • Breadcrumbs and table of contents • Search with Ctrl+K	• Professional appearance • Easy navigation • Quick content discovery • Instant search functionality
Advanced Features	• Copy-to-clipboard in code blocks • Functional internal links • SEO optimized • Full accessibility	• Developer-friendly • Seamless navigation • Better search rankings • Inclusive for all users
Mobile Experience	• Collapsible menu • Touch-friendly • Fast loading • Smooth scrolling	• Mobile-first design • Intuitive interactions • Optimal performance • Enhanced UX

📊 Comparison with Other Tools

Feature	Documentation	GitBook	Notion	Wiki
Simplicity	✅ Pure Markdown	❌ Complex interface	❌ Proprietary	❌ Specific syntax
Performance	✅ Static sites	⚠️ Slow loading	⚠️ Internet dependent	❌ Server required
Customization	✅ Themes and config	❌ Limited	❌ Very limited	⚠️ Requires programming
Search	✅ Instant	✅ Good	✅ Good	⚠️ Basic
Cost	✅ Free	❌ Paid	❌ Paid	⚠️ Self-hosting
Offline	✅ Works	❌ No	❌ No	❌ No

🏆 Benefits for Teams

Team Role	Benefits	Impact
For Developers	• Documentation lives with the code • Familiar and versionable Markdown • Easy CI/CD setup • No vendor lock-in	• Streamlined workflow • Version control integration • Automated deployments • Future-proof solution
For Managers	• Reduces onboarding time • Improves team communication • Always up-to-date documentation • Zero infrastructure cost	• Faster team productivity • Better collaboration • Reliable information • Cost-effective solution
For Users	• Intuitive and fast interface • Efficient search • Works on any device • Always available	• Enhanced user experience • Quick information access • Cross-platform compatibility • Reliable availability

📈 Stats

Repo Stats

💡 Remember: Documentation is made to be simple. Focus on content, let the tool handle the presentation!