OpenInvoice Documentation

Documentation site for OpenInvoice - A modern invoice management system built with Next.js

This is the documentation site for OpenInvoice, built with Docus and Nuxt Content. It provides comprehensive guides for both end users and developers.

📚 Documentation Sections

• Getting Started - Introduction, installation, and first steps
• User Guide - End-user documentation covering invoices, customers, products, payments, and features
• Developer Guide - Technical documentation including setup, architecture, integrations, and deployment
• Troubleshooting - Solutions to common issues and FAQs

🚀 Quick Start

Prerequisites

• Node.js 18+ or Bun

Development

# Install dependencies
npm install

# Start development server
npm run dev

The documentation site will be running at http://localhost:3000

Build for Production

# Build the documentation site
npm run build

The built files will be in the .output directory, ready for deployment.

📁 Project Structure

documentation/
├── content/                    # Markdown documentation files
│   ├── 1.getting-started/     # Getting started guides
│   ├── 2.user-guide/          # End-user documentation
│   ├── 3.developer-guide/     # Developer documentation
│   └── 4.troubleshooting/     # Troubleshooting guides
├── public/                     # Static assets
└── package.json                # Dependencies and scripts

🔗 Related Links

• Main Project - OpenInvoice Repository
• Docus Documentation - docus.dev

📝 Contributing

To contribute to the documentation:

1. Edit the markdown files in the content/ directory
2. Follow the existing structure and naming conventions
3. Use Docus components and features as documented in the Docus docs

⚡ Built With

• Nuxt 4 - The web framework
• Nuxt Content - File-based CMS
• Nuxt UI - UI components
• Docus Layer - Documentation theme
• Tailwind CSS 4 - Utility-first CSS

📄 License

MIT License