npm package: @riligar/documentation
Description: Documentation is a modern static documentation generator that transforms Markdown files into professional documentation sites.
Author: Ciro Cesar Maciel
Latest version: 1.13.1

# Documentation - Modern Documentation Generator

[![GitHub stars](https://img.shields.io/github/stars/riligar/documentation)](https://github.com/riligar/documentation/stargazers) ![GitHub License](https://img.shields.io/github/license/riligar/documentation) [![Documentation](https://img.shields.io/badge/docs-documentation.riligar.click-blue)](https://documentation.riligar.click) [![NPM Version](https://img.shields.io/npm/v/%40riligar%2Fdocumentation)
](https://www.npmjs.com/package/@riligar/documentation)

## 🎯 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

```bash
# 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

1. **Initialize a new project**:

   ```bash
   documentation init my-docs
   cd my-docs
   ```

2. **Start development server**:

   ```bash
   documentation dev
   ```

3. **Build for production**:
   ```bash
   documentation build
   ```

## 🎨 What you get automatically

| Category                   | Features                                                                                                                   | Benefits                                                                                                      |
| -------------------------- | -------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| **Professional Interface** | • Modern and clean design<br>• Automatic sidebar navigation<br>• Breadcrumbs and table of contents<br>• Search with Ctrl+K | • Professional appearance<br>• Easy navigation<br>• Quick content discovery<br>• Instant search functionality |
| **Advanced Features**      | • Copy-to-clipboard in code blocks<br>• Functional internal links<br>• SEO optimized<br>• Full accessibility               | • Developer-friendly<br>• Seamless navigation<br>• Better search rankings<br>• Inclusive for all users        |
| **Mobile Experience**      | • Collapsible menu<br>• Touch-friendly<br>• Fast loading<br>• Smooth scrolling                                             | • Mobile-first design<br>• Intuitive interactions<br>• Optimal performance<br>• 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<br>• Familiar and versionable Markdown<br>• Easy CI/CD setup<br>• No vendor lock-in       | • Streamlined workflow<br>• Version control integration<br>• Automated deployments<br>• Future-proof solution         |
| **For Managers**   | • Reduces onboarding time<br>• Improves team communication<br>• Always up-to-date documentation<br>• Zero infrastructure cost | • Faster team productivity<br>• Better collaboration<br>• Reliable information<br>• Cost-effective solution           |
| **For Users**      | • Intuitive and fast interface<br>• Efficient search<br>• Works on any device<br>• Always available                           | • Enhanced user experience<br>• Quick information access<br>• Cross-platform compatibility<br>• Reliable availability |

## 📈 Stats

![Repo Stats](https://repobeats.axiom.co/api/embed/55571d3a82e502a0e57b6fe8c54864cd53e7e5ac.svg)

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