OI Laravel Documentation

OI Laravel Documentation is a comprehensive package for managing markdown-based documentation sites within your Laravel application. It provides everything you need to create beautiful, searchable documentation with minimal configuration.

What You Get

Markdown-Based Content

Write your documentation in clean, readable markdown. The package automatically discovers and organizes your documentation files based on the directory structure.

Hierarchical Navigation

Navigation is auto-generated from your file structure and meta.json files. No manual configuration needed—just organize your files and let the package handle the rest.

Full-Text Search

Built-in full-text search with relevance scoring allows your users to quickly find the information they need. Search scores are based on title matches, descriptions, headings, and content.

React & Inertia.js Components

Pre-built React components using ShadCN UI provide a beautiful, modern interface out of the box. All components are fully customizable since they're published to your project.

Syntax Highlighting

Code blocks automatically get syntax highlighting via Shiki, supporting all major programming languages including PHP, TypeScript, JavaScript, Bash, JSON, and more.

Table of Contents

Automatic table of contents generation for each page, making it easy for users to navigate long documents.

Previous & Next Navigation

Each page automatically includes links to the previous and next pages in the navigation tree, improving readability flow.

Requirements

To use OI Laravel Documentation, you'll need:

• PHP 8.3 or higher
• Laravel 11 or higher
• Inertia.js (for the frontend)

Quick Start

Ready to get started? Head over to the Installation guide to set up the package in your Laravel application.

Features at a Glance

• 📝 Zero-configuration markdown documentation
• 🧭 Auto-generated hierarchical navigation
• 🔍 Full-text search with relevance scoring
• ⚛️ React components with ShadCN UI
• 🎨 Syntax highlighting with Shiki
• 📱 Responsive design with Tailwind CSS
• 🔐 Configurable access control
• 🎯 SEO-friendly URLs and metadata
• 📦 Package documentation import system
• 🚀 Easy customization and theming