PHPackages                             lynkbyte/docs-builder - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. lynkbyte/docs-builder

ActiveLibrary[API Development](/categories/api)

lynkbyte/docs-builder
=====================

A Laravel-powered static documentation site generator that compiles Markdown and OpenAPI YAML into themed, searchable HTML.

v1.7.0(1mo ago)16311[1 PRs](https://github.com/LynkByte/docs-builder/pulls)MITPHPPHP ^8.3CI passing

Since Feb 11Pushed 1mo agoCompare

[ Source](https://github.com/LynkByte/docs-builder)[ Packagist](https://packagist.org/packages/lynkbyte/docs-builder)[ RSS](/packages/lynkbyte-docs-builder/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (20)Versions (26)Used By (0)

 [![PHP Version](https://camo.githubusercontent.com/cd764a7160e244d5b438a7f7e0696ef23d39903e5021e3628c6c712c1ce93178/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048502d382e332b2d3838393242463f7374796c653d666c61742d737175617265266c6f676f3d706870266c6f676f436f6c6f723d7768697465)](https://camo.githubusercontent.com/cd764a7160e244d5b438a7f7e0696ef23d39903e5021e3628c6c712c1ce93178/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048502d382e332b2d3838393242463f7374796c653d666c61742d737175617265266c6f676f3d706870266c6f676f436f6c6f723d7768697465) [![Laravel Version](https://camo.githubusercontent.com/1dfd8301a313288ec6e4f6c88b75e9124a09062e73f1b30eb1e6df3e62ab6a93/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c61726176656c2d31312e782532307c25323031322e782532307c25323031332e782d4646324432303f7374796c653d666c61742d737175617265266c6f676f3d6c61726176656c266c6f676f436f6c6f723d7768697465)](https://camo.githubusercontent.com/1dfd8301a313288ec6e4f6c88b75e9124a09062e73f1b30eb1e6df3e62ab6a93/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c61726176656c2d31312e782532307c25323031322e782532307c25323031332e782d4646324432303f7374796c653d666c61742d737175617265266c6f676f3d6c61726176656c266c6f676f436f6c6f723d7768697465) [![Tailwind CSS](https://camo.githubusercontent.com/b8a2f4509bda7623090c12d0da00b67e8a05992253acd60b1db3fda49dcc4f43/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5461696c77696e642532304353532d76342d3338424446383f7374796c653d666c61742d737175617265266c6f676f3d7461696c77696e64637373266c6f676f436f6c6f723d7768697465)](https://camo.githubusercontent.com/b8a2f4509bda7623090c12d0da00b67e8a05992253acd60b1db3fda49dcc4f43/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5461696c77696e642532304353532d76342d3338424446383f7374796c653d666c61742d737175617265266c6f676f3d7461696c77696e64637373266c6f676f436f6c6f723d7768697465) [![License](https://camo.githubusercontent.com/152aa2a37725b9fd554b28ff24d270f6071c67927a63e6d635a55c8e188e20c7/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d4d49542d677265656e3f7374796c653d666c61742d737175617265)](https://camo.githubusercontent.com/152aa2a37725b9fd554b28ff24d270f6071c67927a63e6d635a55c8e188e20c7/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d4d49542d677265656e3f7374796c653d666c61742d737175617265)

Docs Builder
============

[](#docs-builder)

A Laravel package that compiles Markdown files and OpenAPI 3.x YAML specifications into a fully themed, searchable, static documentation site — with zero frontend build step required.

Features
--------

[](#features)

- **Markdown with GFM** — Tables, task lists, strikethrough, and all GitHub Flavored Markdown extensions
- **Server-side syntax highlighting** — 15+ languages via [Tempest Highlight](https://github.com/tempestphp/highlight), with styled code blocks, language labels, and copy-to-clipboard buttons
- **Mermaid diagrams** — Render flowcharts, sequence diagrams, ERDs, and more using fenced `mermaid` code blocks, with automatic dark/light theme support, zoom in/out, pan (drag-to-scroll), and fullscreen
- **Image support** — Standalone images are wrapped in `` with alt-text captions, click-to-zoom lightbox overlay, and lazy loading for all images
- **Video embeds** — YouTube and Vimeo URLs are auto-embedded as privacy-enhanced iframes; local `.mp4`/`.webm`/`.ogg` URLs render as native `` elements with responsive 16:9 containers
- **OpenAPI 3.x API reference** — Auto-generates endpoint pages from your YAML spec with parameters, responses, and an interactive "Try it out" panel
- **Client-side search** — Instant full-text search powered by [Fuse.js](https://www.fusejs.io/) with a keyboard-driven command palette (`Cmd+K` / `Ctrl+K`)
- **Dark / light theme** — Class-based toggle with OS preference detection and `localStorage` persistence
- **Multiple visual themes** — Ships with a `default` theme (cool blue tones) and a `modern` theme (warm amber/gold, inspired by Mintlify and Laravel docs). Switch with a single config key.
- **Responsive 3-column layout** — Sidebar navigation, content area, and table of contents with mobile slide-in sidebar
- **Pre-compiled assets** — Ships with production-ready CSS and JS in `dist/` — no Node.js or build step needed
- **Optional Vite integration** — Opt into the host app's Vite pipeline for full asset customization
- **Fully configurable** — Logo, header navigation, Google Fonts, CSS theme overrides, Material Symbols icons, footer, and more
- **Publishable views** — Override any Blade template for complete control over the HTML output

Requirements
------------

[](#requirements)

- PHP 8.3 or higher
- Laravel 11.x, 12.x, or 13.x

Installation
------------

[](#installation)

```
composer require lynkbyte/docs-builder
```

The package auto-discovers its service provider — no manual registration needed.

Quick Start
-----------

[](#quick-start)

**1. Scaffold starter files**

```
php artisan docs:init
```

This creates:

- `config/docs-builder.php` — the configuration file
- `docs/README.md` — a starter documentation page
- `docs/openapi.yaml` — a minimal OpenAPI spec

**2. Build the documentation**

```
php artisan docs:build
```

**3. View the output**

The static site is written to `public/docs/` by default. Open `public/docs/index.html` in your browser, or visit `/docs` if your app is running.

Configuration Reference
-----------------------

[](#configuration-reference)

Publish the config file (or use the one created by `docs:init`):

```
php artisan vendor:publish --tag=docs-builder-config
```

### Site Settings

[](#site-settings)

```
// config/docs-builder.php

'site_name' => 'My Documentation',

'site_description' => 'Documentation for my project',

// Directory containing your Markdown source files
'source_dir' => base_path('docs'),

// Where the built HTML is written
'output_dir' => public_path('docs'),

// OpenAPI YAML spec for API reference generation
'openapi_file' => base_path('docs/openapi.yaml'),

// URL path prefix for all generated links
'base_url' => '/docs',
```

### Appearance

[](#appearance)

#### Logo

[](#logo)

```
// null = default diamond SVG
'logo' => null,

// Inline SVG
'logo' => '...',

// HTML with an image
'logo' => '',
```

#### Header Navigation

[](#header-navigation)

```
// null = defaults (Guides, API Reference, Examples)
'header_nav' => null,

// Custom links
'header_nav' => [
    ['title' => 'Guides', 'url' => '/docs'],
    ['title' => 'API', 'url' => '/docs/api-reference'],
    ['title' => 'Blog', 'url' => '/blog'],
],
```

#### Fonts

[](#fonts)

```
// Default: Inter + JetBrains Mono + Material Symbols
'fonts' => [
    'https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700;900&family=JetBrains+Mono:wght@400;500;600&display=swap',
    'https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:wght,FILL@100..700,0..1&display=swap',
],

// Disable external fonts entirely
'fonts' => false,
```

> **Note:** Material Symbols Outlined is used for sidebar page icons and UI elements. If you disable fonts, icons will not render unless you provide them through another mechanism.

#### Theme Name

[](#theme-name)

Switch between built-in visual themes with a single config key:

```
// Default: cool blue DevDocs-inspired theme
'theme_name' => 'default',

// Modern: warm amber/gold theme inspired by Mintlify and Laravel docs
'theme_name' => 'modern',
```

Both themes support dark/light mode, all the same features, and the same configuration options. The modern theme has a warmer color palette, refined typography, and a polished card-based layout.

#### Theme Overrides

[](#theme-overrides)

Override the default CSS custom properties by setting key-value pairs. These are injected as an inline `` block on `:root`.

```
'theme' => [
    'color-primary'       => '#8b5cf6',
    'color-primary-light' => '#a78bfa',
    'color-primary-dark'  => '#7c3aed',
    'color-dark-bg'       => '#0a0a0a',
    'color-light-bg'      => '#fafafa',
],
```

**All available theme variables**VariableDefaultDescription`color-primary``#137fec`Primary brand color (links, active states)`color-primary-light``#3b9af5`Lighter primary variant (hover states)`color-primary-dark``#0d6ad4`Darker primary variant`color-dark-bg``#101922`Dark mode background`color-dark-surface``#1a2632`Dark mode surface (cards, sidebar)`color-dark-border``#233648`Dark mode borders`color-dark-muted``#92adc9`Dark mode muted text`color-dark-text``#e2e8f0`Dark mode primary text`color-dark-text-secondary``#cbd5e1`Dark mode secondary text`color-light-bg``#f6f7f8`Light mode background`color-light-surface``#ffffff`Light mode surface`color-light-border``#e2e8f0`Light mode borders`color-light-muted``#94a3b8`Light mode muted text`color-light-text``#0f172a`Light mode primary text`color-light-text-secondary``#475569`Light mode secondary text`color-code-bg``#0d1117`Code block background`color-code-header``#1a2632`Code block header background`color-code-border``#233648`Code block border`color-code-text``#f1f5f9`Code block text### Navigation

[](#navigation)

The sidebar navigation is defined as an array of sections, each containing an array of pages:

```
'navigation' => [
    [
        'title' => 'Getting Started',
        'pages' => [
            ['title' => 'Home', 'file' => 'README.md', 'icon' => 'home'],
            ['title' => 'Installation', 'file' => 'installation.md', 'icon' => 'download'],
        ],
    ],
    [
        'title' => 'API',
        'pages' => [
            ['title' => 'API Reference', 'file' => 'api-reference.md', 'icon' => 'api', 'layout' => 'api-reference'],
        ],
    ],
],
```

Each page entry supports:

KeyRequiredDescription`title`YesDisplay title in the sidebar and page heading`file`YesMarkdown filename (relative to `source_dir`)`icon`No[Material Symbols](https://fonts.google.com/icons) icon name`layout`No`'documentation'` (default) or `'api-reference'`Pages using the `api-reference` layout render with the API sidebar (tags, endpoints) instead of the standard documentation sidebar.

### API Settings

[](#api-settings)

```
// Auto-generated from openapi.yaml tags if left empty
'api_navigation' => [],

// Map OpenAPI tags to Material Symbols icon names
'api_tag_icons' => [
    'Authentication' => 'lock',
    'Users'          => 'group',
    'Bookings'       => 'calendar_month',
    // Unlisted tags fall back to 'api'
],
```

### Footer

[](#footer)

```
'footer' => [
    'copyright' => '© ' . date('Y') . ' My Company. All rights reserved.',
    'links' => [
        ['title' => 'Privacy Policy', 'url' => '/privacy'],
        ['title' => 'GitHub', 'url' => 'https://github.com/my-org'],
    ],
],
```

### Support URL

[](#support-url)

```
// Show a "Contact Support" link in the table of contents sidebar
'support_url' => 'mailto:support@example.com',

// Set to null to hide the support card entirely (default)
'support_url' => null,
```

Writing Documentation
---------------------

[](#writing-documentation)

### Markdown Files

[](#markdown-files)

Place your Markdown files in the `source_dir` directory (`docs/` by default). The builder supports all standard Markdown plus GitHub Flavored Markdown extensions:

FeatureSyntaxTables`| Header | Header |`Task lists`- [x] Done`Strikethrough`~~text~~`Fenced code blocks````php`Heading anchorsAuto-generated from heading text### YAML Front Matter

[](#yaml-front-matter)

Optionally add front matter to your Markdown files:

```
---
title: Installation Guide
---

# Installation

Your content here...
```

### Syntax Highlighting

[](#syntax-highlighting)

Fenced code blocks are syntax-highlighted server-side. Supported languages:

`php`, `blade`, `html`, `css`, `javascript`/`js`, `typescript`/`ts`, `json`, `bash`/`shell`/`sh`, `sql`, `yaml`/`yml`, `xml`

```
    ```php
    $user = User::find(1);
    ```
```

Code blocks render with a language label in the header and a copy-to-clipboard button.

### Mermaid Diagrams

[](#mermaid-diagrams)

Fenced code blocks with the `mermaid` language are rendered as interactive diagrams using [Mermaid JS](https://mermaid.js.org/). Flowcharts, sequence diagrams, class diagrams, ERDs, Gantt charts, and all other Mermaid diagram types are supported.

```
```mermaid
graph TD
    A[Start] --> B{Decision}
    B -->|Yes| C[Do something]
    B -->|No| D[Do something else]
```
```

Diagrams automatically adapt when the user toggles between dark and light themes. Each diagram includes a toolbar with zoom in/out, reset, pan (drag-to-scroll), and fullscreen controls. Pan is enabled by default when diagrams are zoomed, allowing click-and-drag navigation. Mermaid JS is loaded from CDN -- no additional dependencies or build steps are required.

### Images

[](#images)

Standard Markdown images are automatically enhanced during the build:

- **Standalone images** (the only content in a paragraph) are wrapped in a `` element. The alt text becomes a `` below the image.
- **Inline images** (mixed with text in the same paragraph) are left inline — they are not wrapped in a figure.
- **Lazy loading** — All images receive `loading="lazy"` for deferred off-screen loading.
- **Lightbox** — Click any image in the documentation content to view it in a fullscreen overlay. Press `Escape` or click outside the image to close.

```

![Architecture overview](images/architecture.png)

Check the icon ![icon](images/check.png) for details.
```

### Videos

[](#videos)

Paste a video URL on its own line (no surrounding text, no Markdown link syntax) and it will be automatically converted into an embedded player:

URL PatternResult`https://www.youtube.com/watch?v=VIDEO_ID`YouTube embed (privacy-enhanced)`https://youtu.be/VIDEO_ID`YouTube embed (privacy-enhanced)`https://vimeo.com/VIDEO_ID`Vimeo embed`https://example.com/video.mp4`Native `` element`https://example.com/video.webm`Native `` element`https://example.com/video.ogg`Native `` element```

https://www.youtube.com/watch?v=dQw4w9WgXcQ

https://vimeo.com/123456789

https://example.com/demo.mp4
```

All video embeds are wrapped in a responsive 16:9 container with rounded corners. YouTube embeds use the `youtube-nocookie.com` domain for privacy-enhanced mode.

> **Note:** The URL must be on its own line and auto-linked by GFM. Explicit Markdown links like `[Watch this](https://youtube.com/...)` are not converted — they remain as regular links.

### Site Name Placeholder

[](#site-name-placeholder)

Use `{SiteName}` anywhere in your Markdown content and it will be replaced with the configured `site_name` value.

API Reference Generation
------------------------

[](#api-reference-generation)

If your project has an OpenAPI 3.x YAML spec, the builder automatically generates individual pages for each endpoint.

### How It Works

[](#how-it-works)

1. Set `openapi_file` in your config to point at your YAML spec
2. Add a page with `'layout' => 'api-reference'` to your navigation — this becomes the API overview page
3. Run `php artisan docs:build`

The builder parses the spec and generates one HTML page per `operationId`, grouped by tag. Each endpoint page includes:

- **Method badge** — Color-coded (`GET` blue, `POST` green, `PUT`/`PATCH` amber, `DELETE` red)
- **Full endpoint path** with the server base URL
- **Parameters table** — Path, query, and request body parameters with types, required flags, and descriptions
- **Responses section** — Status codes with descriptions and JSON examples
- **"Try it out" panel** — Interactive form to send requests with a generated cURL command and live response viewer

### Tag Icons

[](#tag-icons)

Map your OpenAPI tags to [Material Symbols](https://fonts.google.com/icons) icons for the API sidebar:

```
'api_tag_icons' => [
    'Authentication' => 'lock',
    'Users'          => 'group',
    'Payments'       => 'payments',
],
```

Any tag not in this map falls back to the `api` icon.

Asset Modes
-----------

[](#asset-modes)

The package supports two modes for handling CSS and JavaScript assets.

### Precompiled (Default)

[](#precompiled-default)

```
'asset_mode' => 'precompiled',
```

Uses the pre-built `docs.css` and `docs.js` from the package's `dist/` directory. The build command copies them directly to your output's `assets/` folder. When a non-default theme is configured, the theme's CSS and JS are also copied from `dist/themes/`.

**Pros:** No Node.js required, instant builds, zero configuration.

**When to use:** Most projects. You just want working documentation with the default theme.

### Vite

[](#vite)

```
'asset_mode' => 'vite',
```

Integrates with your host application's Vite build pipeline. The build command runs `npx vite build` and reads the generated manifest to locate and copy the compiled assets.

To use Vite mode, add the package's CSS and JS as entry points in your app's `vite.config.js`:

```
// vite.config.js
laravel({
    input: [
        'resources/css/app.css',
        'resources/js/app.js',
        // Add these for docs asset customization:
        'vendor/lynkbyte/docs-builder/resources/css/docs.css',
        'vendor/lynkbyte/docs-builder/resources/js/docs.js',
    ],
}),
```

**Pros:** Full control over CSS and JS, can extend Tailwind theme, can add custom JavaScript.

**When to use:** You need to customize the docs styles beyond what theme overrides provide, or want to bundle additional frontend code.

Commands
--------

[](#commands)

### `docs:build`

[](#docsbuild)

Build the static documentation site.

```
php artisan docs:build
```

OptionDescription`--skip-assets`Skip copying/compiling CSS and JS assets. Useful when assets haven't changed and you only need to rebuild HTML.```
# Rebuild only HTML pages, skip asset handling
php artisan docs:build --skip-assets
```

### `docs:init`

[](#docsinit)

Scaffold a starter documentation directory with example files.

```
php artisan docs:init
```

OptionDescription`--force`Overwrite existing config and stub files if they already exist.```
# Overwrite existing files
php artisan docs:init --force
```

### `docs:ai`

[](#docsai)

Publish AI coding assistant configurations for docs-builder. Creates context files for various AI tools so they understand the package.

```
php artisan docs:ai
```

OptionDescription`--force`Replace existing docs-builder sections (preserves your custom content in the file).When run interactively, the command presents a multi-select prompt to choose which AI tool configurations to include. In non-interactive mode (CI, testing), all tools are published.

**Behavior for appendable files** (`llms.txt`, `llms-full.txt`, `copilot-instructions.md`, `CLAUDE.md`):

- **File missing** — Creates the file with docs-builder content wrapped in sentinel markers
- **File exists, no markers** — Appends with a `---` separator
- **File exists, has markers** — Skips (use `--force` to replace)
- **`--force`** — Replaces only the docs-builder section, preserving your content

**Behavior for standalone files** (`.cursor/rules/docs-builder.mdc`):

- **File missing** — Creates the file
- **File exists** — Skips (use `--force` to overwrite)

ToolFiles CreatedDestination`llms``llms.txt`, `llms-full.txt`Project root`cursor``docs-builder.mdc``.cursor/rules/``copilot``copilot-instructions.md``.github/``claude``CLAUDE.md`Project rootPublishing
----------

[](#publishing)

The package offers seven publishable groups so you can customize any part of the documentation:

TagWhat's PublishedDestination`docs-builder-config`Configuration file`config/docs-builder.php``docs-builder-views`All Blade templates`resources/views/vendor/docs-builder/``docs-builder-assets`Pre-compiled CSS/JS`public/docs/assets/``docs-builder-css`CSS source file`resources/css/docs.css``docs-builder-js`JavaScript source file`resources/js/docs.js``docs-builder-stubs`Init scaffold templates`stubs/docs-builder/``docs-builder-llms`LLM documentation files`llms.txt`, `llms-full.txt````
# Publish individual groups
php artisan vendor:publish --tag=docs-builder-config
php artisan vendor:publish --tag=docs-builder-views
php artisan vendor:publish --tag=docs-builder-assets
php artisan vendor:publish --tag=docs-builder-css
php artisan vendor:publish --tag=docs-builder-js
php artisan vendor:publish --tag=docs-builder-stubs
php artisan vendor:publish --tag=docs-builder-llms
```

### Customizing Templates

[](#customizing-templates)

Published views are placed in `resources/views/vendor/docs-builder/` and take priority over the package views, allowing you to modify any template:

```
views/vendor/docs-builder/docs/
├── layouts/
│   ├── base.blade.php            # Root HTML document (head, scripts, styles)
│   ├── documentation.blade.php   # Standard doc page (sidebar + content + TOC)
│   └── api-reference.blade.php   # API reference page (API sidebar + content)
├── partials/
│   ├── header.blade.php          # Top navigation bar (logo, nav links, search, theme toggle)
│   ├── sidebar.blade.php         # Left sidebar navigation
│   ├── toc.blade.php             # Right-side table of contents
│   ├── search-modal.blade.php    # Search command palette overlay
│   └── footer.blade.php          # Site footer
└── themes/
    └── modern/docs/              # Modern theme overrides (same structure as above)
        ├── layouts/
        └── partials/

```

### Customizing Styles

[](#customizing-styles)

For changes beyond what [theme overrides](#theme-overrides) offer (e.g. modifying animations, sidebar width, typography, or syntax highlighting colors), publish the CSS source and switch to Vite mode:

```
# 1. Publish the CSS source file
php artisan vendor:publish --tag=docs-builder-css

# 2. Add it as a Vite entry point in your vite.config.js
#    (see Asset Modes > Vite section above)

# 3. Set asset_mode to 'vite' in config/docs-builder.php
```

The published `resources/css/docs.css` is a full Tailwind CSS v4 file with the `@theme` block, all custom styles, and syntax highlighting classes. Edit it freely — when in Vite mode, the build command automatically detects published source files in your app's `resources/` directory.

### Customizing JavaScript

[](#customizing-javascript)

Publish the JS source to modify search behavior, theme toggling, keyboard shortcuts, or add your own functionality:

```
php artisan vendor:publish --tag=docs-builder-js
```

This copies `resources/js/docs.js` to your app. Like the CSS, it's auto-detected when using Vite mode.

### Customizing Init Stubs

[](#customizing-init-stubs)

Publish the stubs to customize what `docs:init` scaffolds for new documentation:

```
php artisan vendor:publish --tag=docs-builder-stubs
```

This copies `README.md` and `openapi.yaml` templates to `stubs/docs-builder/`. When published stubs exist, `docs:init` uses them instead of the package defaults.

Search
------

[](#search)

The builder generates a `search-index.json` file in the output directory containing all documentation pages and API endpoints. Search is powered by [Fuse.js](https://www.fusejs.io/) on the client side.

**Keyboard shortcut:** `Cmd+K` (macOS) / `Ctrl+K` (Windows/Linux) opens the search command palette.

The search index is lazy-loaded on first use and includes:

- Page titles (highest weight)
- Section headings (high weight)
- Page content (medium weight)
- Section names (lower weight)

Results are grouped by section with icons and, for API endpoints, method badges.

Dependencies
------------

[](#dependencies)

PackagePurpose[league/commonmark](https://commonmark.thephpleague.com/)Markdown to HTML conversion with GFM extensions[symfony/yaml](https://symfony.com/doc/current/components/yaml.html)OpenAPI YAML spec parsing[tempest/highlight](https://github.com/tempestphp/highlight)Server-side syntax highlighting for code blocks[fuse.js](https://www.fusejs.io/)Client-side fuzzy search (bundled in pre-compiled JS)[Mermaid JS](https://mermaid.js.org/)Client-side diagram rendering (loaded from CDN)[Tailwind CSS v4](https://tailwindcss.com/)Utility-first styling (bundled in pre-compiled CSS)LLM Documentation
-----------------

[](#llm-documentation)

This repository includes machine-readable documentation for LLMs and AI coding assistants:

FilePurpose[`llms.txt`](llms.txt)Concise package overview following the [llms.txt standard](https://llmstxt.org/)[`llms-full.txt`](llms-full.txt)Comprehensive reference with full configuration, class API, and examples[`.cursor/rules/docs-builder.mdc`](.cursor/rules/docs-builder.mdc)AI coding rules for [Cursor](https://cursor.com/) and compatible assistantsRun `php artisan docs:ai` to publish AI tool configurations for your project. You can also publish the LLM files separately:

```
php artisan vendor:publish --tag=docs-builder-llms
```

Contributing
------------

[](#contributing)

Contributions are welcome. Here's how to get started:

```
# Clone the repository
git clone https://github.com/lynkbyte/docs-builder.git
cd docs-builder

# Install dependencies
composer install
npm install

# Run the test suite
vendor/bin/pest

# Build pre-compiled assets
npm run build
```

Before submitting a pull request:

1. **Code style** — Run `vendor/bin/pint` to auto-fix formatting (PSR-12)
2. **Tests** — Add tests for any new functionality and ensure all existing tests pass
3. **One concern per PR** — Keep pull requests focused on a single change
4. **Descriptive title** — Use a clear, concise title that summarizes the change

Security Vulnerabilities
------------------------

[](#security-vulnerabilities)

If you discover a security vulnerability within Docs Builder, please report it responsibly. **Do not open a public issue.** Instead, email  directly. All reports will be reviewed promptly and handled with care.

License
-------

[](#license)

Docs Builder is open-sourced software licensed under the [MIT license](LICENSE).

###  Health Score

48

—

FairBetter than 95% of packages

Maintenance90

Actively maintained with recent releases

Popularity22

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity59

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 97.9% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~5 days

Total

11

Last Release

45d ago

PHP version history (2 changes)v1.0.0PHP ^8.2

v1.1.0PHP ^8.3

### Community

Maintainers

![](https://www.gravatar.com/avatar/8c76cf9191833d35a466be0ecf87e6487ae77daa74fbd468de13693bba8c756a?d=identicon)[san3jaya](/maintainers/san3jaya)

---

Top Contributors

[![san3jaya](https://avatars.githubusercontent.com/u/8122779?v=4)](https://github.com/san3jaya "san3jaya (46 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (1 commits)")

---

Tags

laraveldocumentationopenapimarkdownstatic-site

###  Code Quality

TestsPest

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/lynkbyte-docs-builder/health.svg)

```
[![Health](https://phpackages.com/badges/lynkbyte-docs-builder/health.svg)](https://phpackages.com/packages/lynkbyte-docs-builder)
```

###  Alternatives

[darkaonline/l5-swagger

OpenApi or Swagger integration to Laravel

2.9k34.0M112](/packages/darkaonline-l5-swagger)[statamic/cms

The Statamic CMS Core Package

4.8k3.2M720](/packages/statamic-cms)[binarytorch/larecipe

Generate gorgeous recipes for your Laravel applications using MarkDown

2.5k2.7M16](/packages/binarytorch-larecipe)[tightenco/jigsaw

Simple static sites with Laravel's Blade.

2.2k438.5k29](/packages/tightenco-jigsaw)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)