PHPackages                             ranetrace/lemme - 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. [Caching](/categories/caching)
4. /
5. ranetrace/lemme

ActiveLibrary[Caching](/categories/caching)

ranetrace/lemme
===============

Laravel package for generating documentation websites from Markdown files

v3.0.6(1mo ago)226↓90%[1 issues](https://github.com/ranetrace/lemme/issues)[1 PRs](https://github.com/ranetrace/lemme/pulls)MITPHPPHP ^8.4CI passing

Since Aug 25Pushed 1mo agoCompare

[ Source](https://github.com/ranetrace/lemme)[ Packagist](https://packagist.org/packages/ranetrace/lemme)[ Docs](https://github.com/ranetrace/lemme)[ RSS](/packages/ranetrace-lemme/feed)WikiDiscussions main Synced 3w ago

READMEChangelog (1)Dependencies (33)Versions (12)Used By (0)

   ![Lemme Art](art/lemme-art.svg)

Lemme - Documentation Generator for Laravel
===========================================

[](#lemme---documentation-generator-for-laravel)

Lemme is a Laravel package that facilitates the creation of beautiful documentation websites from Markdown files. It provides a simple way to turn your project's documentation into a fully-featured website with a modern, responsive design. All from within your Laravel application.

[![Latest Version on Packagist](https://camo.githubusercontent.com/bf131a341dc6ae322e9c9da34d4007069440e18b1170fe35c4a0b2275cffa686/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f72616e6574726163652f6c656d6d652e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/ranetrace/lemme)

Table of Contents
-----------------

[](#table-of-contents)

- [Quick Start](#quick-start)
- [Features](#features)
- [Installation](#installation)
- [Configuration](#configuration)
    - [Logo Customization](#logo-customization)
    - [Favicon Customization](#favicon-customization)
    - [Customizing Markdown Rendering](#customizing-markdown-rendering)
- [Usage](#usage)
    - [Creating Documentation](#creating-documentation)
        - [Slug Configuration](#slug-configuration)
            - [Index Pages & Nested Index Behavior](#index-pages--nested-index-behavior)
            - [Duplicate Slug Handling](#duplicate-slug-handling)
            - [Quick Reference Summary](#quick-reference-summary)
    - [Directory-based Navigation Grouping](#directory-based-navigation-grouping)
    - [Accessing Documentation](#accessing-documentation)
    - [API Access (Optional)](#api-access-optional)
    - [Commands](#commands)
    - [Publishing Assets / Views / Config](#publishing-assets--views--config)
    - [Cache & Reindex Details](#cache--reindex-details)
    - [Heading Anchors](#heading-anchors)
    - [Search Index](#search-index)
    - [Troubleshooting Slugs](#troubleshooting-slugs)
    - [Using the Facade](#using-the-facade)
- [Themes](#themes)
- [Performance](#performance)
- [Subdomain Setup (Optional)](#subdomain-setup-optional)
- [Development](#development)
    - [Building Assets](#building-assets)
- [Contributing](#contributing)
- [License](#license)
- [Credits](#credits)

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

[](#quick-start)

Lemme makes it super easy to create and maintain documentation for your Laravel projects.

Just run `php artisan lemme:install`, write your docs in the `docs/` folder and your documentation site is ready!

It's really that simple. And totally free.

Features
--------

[](#features)

- **Markdown-based**: Write your documentation in simple Markdown files inside the `docs/` directory in your project
- **Beautiful UI**: Modern design (Tailwind CSS 4 + dark mode) out of the box
- **Responsive**: Works on all devices
- **Fast**: Built-in caching (pages, HTML, search) with rotation
- **Flexible routing**: Serve via route prefix (default) or a subdomain
- **Configurable**: Directories, navigation sorting/grouping, logo rendering, search limits
- **Laravel-native**: Service provider, facade, Livewire component
- **Syntax highlighting**: Shiki-driven code highlighting (light & dark themes)
- **Directory grouping**: Automatic navigation tree from folder structure
- **Search-ready**: Plain‑text index built from rendered Markdown
- **Anchors**: Stable heading IDs with automatic de‑duplication

> Note: The `theme` config key is currently a placeholder (only the bundled default + dark mode variant ships). Extra named themes are not yet implemented.

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

[](#installation)

Install the package via Composer:

```
composer require ranetrace/lemme
```

Install the documentation system:

```
php artisan lemme:install
```

This will:

- Create a `docs` directory in your project root
- Generate sample documentation files with **numbered structure**
- Publish the compiled Tailwind CSS assets
- Set up the necessary configuration

**Example navigation structure (illustrative):**

```
docs/
├── index.md
├── 1_getting-started/
│   ├── 1_installation.md
│   ├── 2_configuration.md
│   └── 3_first-steps.md
├── 2_api/
│   ├── 1_authentication.md
│   ├── 2_endpoints.md
│   └── 3_advanced/
│       ├── 1_webhooks.md
│       └── 2_rate-limiting.md
└── 3_guides/
    ├── 1_deployment.md
    └── 2_troubleshooting.md

```

**What the installer actually creates:**

```
docs/
├── index.md
└── 1_welcome/
    ├── 1_getting-started.md
    └── 2_organizing-content.md

```

Add further folders/files manually following the same naming conventions.

Configuration
-------------

[](#configuration)

Use the environment variables or edit `config/lemme.php` to customize your documentation website:

```
return [
    /*
    |--------------------------------------------------------------------------
    | Documentation Directory
    |--------------------------------------------------------------------------
    |
    | This is the directory where your markdown documentation files are stored.
    | By default, it's 'docs' but you can change it to any directory you prefer.
    |
    */
    'docs_directory' => env('LEMME_DOCS_DIRECTORY', 'docs'),

    /*
    |--------------------------------------------------------------------------
    | Subdomain
    |--------------------------------------------------------------------------
    |
    | The subdomain where your documentation will be served.
    | Leave as null to use route prefix instead (e.g., yoursite.com/docs).
    |
    */
    'subdomain' => env('LEMME_SUBDOMAIN', null),

    /*
    |--------------------------------------------------------------------------
    | Route Prefix
    |--------------------------------------------------------------------------
    |
    | The route prefix where your documentation will be served.
    | By default, it's 'docs' (e.g., yoursite.com/docs).
    | Set to null to use subdomain routing instead.
    |
    */
    'route_prefix' => env('LEMME_ROUTE_PREFIX', 'docs'),

    /*
    |--------------------------------------------------------------------------
    | Theme
    |--------------------------------------------------------------------------
    |
    | Placeholder for future theme variants. (Currently only the bundled
    | default style + dark mode toggle is provided.)
    |
    */
    'theme' => env('LEMME_THEME', 'default'),

    /*
    |--------------------------------------------------------------------------
    | Site Title
    |--------------------------------------------------------------------------
    |
    | The title of your documentation site.
    |
    */
    'site_title' => env('LEMME_SITE_TITLE', 'Documentation'),

    /*
    |--------------------------------------------------------------------------
    | Site Description
    |--------------------------------------------------------------------------
    |
    | A brief description of your documentation site.
    |
    */
    'site_description' => env('LEMME_SITE_DESCRIPTION', 'Project Documentation'),

    /*
    |--------------------------------------------------------------------------
    | Navigation
    |--------------------------------------------------------------------------
    |
    | Configure how navigation is generated from your markdown files.
    |
    */
    'navigation' => [
        'auto_generate' => true,
        'sort_by' => 'filename', // 'filename', 'title', 'created_at', 'modified_at'
        'sort_direction' => 'asc',

        // Directory-based grouping
        'grouping' => [
            'enabled' => true,
            'sort_groups_by' => 'directory_name', // 'directory_name', 'title'
            'sort_groups_direction' => 'asc',
        ],
    ],

    /*
    |--------------------------------------------------------------------------
    | Cache
    |--------------------------------------------------------------------------
    |
    | Enable caching for better performance in production.
    |
    */
    'cache' => [
        'enabled' => env('LEMME_CACHE_ENABLED', true),
        'ttl' => env('LEMME_CACHE_TTL', 3600), // 1 hour
    ],

    /*
    |--------------------------------------------------------------------------
    | Search
    |--------------------------------------------------------------------------
    |
    | Configure search functionality settings.
    |
    */
    'search' => [
        'max_content_length' => env('LEMME_SEARCH_MAX_CONTENT_LENGTH', 0), // 0 = no limit (index full content)
    ],

    /*
    |--------------------------------------------------------------------------
    | API Endpoints
    |--------------------------------------------------------------------------
    |
    | Optional JSON API exposing documentation structure & page data.
    | Disabled by default; enable via env when you need headless access.
    |
    */
    'api' => [
        'enabled' => env('LEMME_API_ENABLED', false),
    ],

    /*
    |--------------------------------------------------------------------------
    | Logo
    |--------------------------------------------------------------------------
    |
    | Configure how the logo in the documentation layout is rendered.
    | Supported types:
    | - view  : renders a Blade view (default existing partial)
    | - image : renders an  tag (provide image path relative to public/ or full URL)
    | - text  : renders plain text inside a
    |
    | You can override via env vars, e.g.:
    |   LEMME_LOGO_TYPE=image
    |   LEMME_LOGO_IMAGE="images/logo.svg"
    |   LEMME_LOGO_ALT="My Project"
    |
    */
    'logo' => [
        'type' => env('LEMME_LOGO_TYPE', 'view'),
        'view' => env('LEMME_LOGO_VIEW', 'lemme::partials.logo'),
        'image' => env('LEMME_LOGO_IMAGE', null),
        'text' => env('LEMME_LOGO_TEXT', null),
        'alt' => env('LEMME_LOGO_ALT', 'Logo'),
        // Additional CSS classes applied to the root element of image/text variants
        'classes' => env('LEMME_LOGO_CLASSES', 'h-6 text-black dark:text-white'),
    ],

    /*
    |--------------------------------------------------------------------------
    | Favicon
    |--------------------------------------------------------------------------
    |
    | Configure the favicon emitted in the documentation layout's .
    | The docs site is served from its own standalone HTML document, so it
    | does not inherit the host application's favicon. Supported types:
    | - none : emit nothing (default; no  at all)
    | - file : emit  (plus optional apple-touch-icon)
    | - view : render a Blade view inside  (escape hatch for a full
    |          modern set: SVG + .ico + apple-touch + manifest + theme-color)
    |
    | You can override via env vars, e.g.:
    |   LEMME_FAVICON_TYPE=file
    |   LEMME_FAVICON_HREF="favicon.ico"
    |   LEMME_FAVICON_MIME="image/x-icon"
    |   LEMME_FAVICON_APPLE_TOUCH="apple-touch-icon.png"
    |
    */
    'favicon' => [
        'type' => env('LEMME_FAVICON_TYPE', 'none'), // none | file | view
        // type=file:
        'href' => env('LEMME_FAVICON_HREF', null),               // path relative to public/ or absolute URL
        'mime' => env('LEMME_FAVICON_MIME', null),                // optional, e.g. image/svg+xml, image/png
        'apple_touch' => env('LEMME_FAVICON_APPLE_TOUCH', null),  // optional path/URL for apple-touch-icon
        // type=view:
        'view' => env('LEMME_FAVICON_VIEW', null),                // Blade view rendered inside
    ],
];
```

### Logo Customization

[](#logo-customization)

You can fully customize the logo displayed in the header. Choose one of three rendering modes via the config file or environment variables.

> Recommended: Use the `view` (Blade partial) option. It's the most flexible and future‑proof approach because you can:
>
> - Swap light/dark variants conditionally
> - Add accessible markup (ARIA labels, screen-reader text)
> - Inject dynamic data (app version, beta badge, etc.)
> - Reuse shared components / Tailwind classes
> - Evolve the logo without changing `.env` variables
>
> The `image` and `text` modes are intentionally lightweight shortcuts, but most projects should create and use a Blade partial.

TypeEnv SettingRequired Extra VarsDescriptionview`LEMME_LOGO_TYPE=view``LEMME_LOGO_VIEW` (optional)Renders a Blade view (default partial)image`LEMME_LOGO_TYPE=image``LEMME_LOGO_IMAGE` (path or URL)Outputs an `` tagtext`LEMME_LOGO_TYPE=text``LEMME_LOGO_TEXT` (string)Simple text logoCommon optional variables:

```
LEMME_LOGO_ALT="My Project"            # Alt text for image variant
LEMME_LOGO_CLASSES="h-6 w-auto"        # Extra classes applied to root element

```

Examples:

Image logo:

```
LEMME_LOGO_TYPE=image
LEMME_LOGO_IMAGE=images/logo.svg
LEMME_LOGO_ALT="Acme Docs"
LEMME_LOGO_CLASSES="h-8 w-auto"

```

Text logo:

```
LEMME_LOGO_TYPE=text
LEMME_LOGO_TEXT="Acme Docs"
LEMME_LOGO_CLASSES="text-lg font-bold"

```

Custom view (via your own Blade partial):

```
LEMME_LOGO_TYPE=view
LEMME_LOGO_VIEW=branding.logo

```

If a required variable for the chosen type is missing (or the view can't be resolved), Lemme gracefully falls back to the default bundled SVG logo.

### Favicon Customization

[](#favicon-customization)

Lemme serves documentation from its own standalone HTML document, so the docs pages do **not** inherit your host application's `` favicon tags. Favicon support is therefore explicit Lemme config, mirroring the [logo](#logo-customization) pattern.

> The default is `none` — Lemme emits **no** favicon markup at all, leaving the docs `` byte-identical to previous versions. Upgrading changes nothing until you opt in.

TypeEnv SettingRequired Extra VarsDescriptionnone`LEMME_FAVICON_TYPE=none`—Emits nothing (default)file`LEMME_FAVICON_TYPE=file``LEMME_FAVICON_HREF` (path/URL)Emits `` (+ optional apple-touch-icon)view`LEMME_FAVICON_TYPE=view``LEMME_FAVICON_VIEW` (view name)Renders your Blade partial inside ``The `href`/`apple_touch` paths follow the same resolution rule as the image logo: a value starting with `http://`, `https://`, or `/` is used verbatim, otherwise it is passed through `asset()` (relative to `public/`). This matters when `LEMME_SUBDOMAIN` is set, since the browser's default `/favicon.ico` request would otherwise resolve against the wrong docroot.

Simple `.ico` favicon:

```
LEMME_FAVICON_TYPE=file
LEMME_FAVICON_HREF=favicon.ico

```

SVG favicon with an Apple touch icon:

```
LEMME_FAVICON_TYPE=file
LEMME_FAVICON_HREF=favicon.svg
LEMME_FAVICON_MIME=image/svg+xml
LEMME_FAVICON_APPLE_TOUCH=apple-touch-icon.png

```

For a full modern set (SVG + `.ico` fallback + apple-touch-icon + `site.webmanifest` + `theme-color` + light/dark `media` queries), use the `view` escape hatch and put all the ``/`` tags in your own Blade partial — Lemme intentionally does not model those individually in config:

```
LEMME_FAVICON_TYPE=view
LEMME_FAVICON_VIEW=branding.favicon

```

If the configured view does not exist, Lemme emits nothing (it does not error and there is no default favicon partial).

### Customizing Markdown Rendering

[](#customizing-markdown-rendering)

Lemme owns a dedicated `MarkdownRenderer` instance configured under `lemme.markdown`. Your host application's `config/markdown.php` (from `spatie/laravel-markdown`) is left untouched — so any other Markdown rendering elsewhere in your app is unaffected by Lemme.

GitHub Flavored Markdown (tables, task lists, autolinks, strikethrough) and heading permalinks are enabled by default, so things like this just work:

```
| Feature | Status |
| ------- | ------ |
| Tables  | ✅     |
| GFM     | ✅     |
```

To add or remove CommonMark extensions, publish the config (`php artisan vendor:publish --tag=lemme-config`) and edit the `markdown.extensions` array:

```
'markdown' => [
    'extensions' => [
        \League\CommonMark\Extension\GithubFlavoredMarkdownExtension::class,
        \League\CommonMark\Extension\HeadingPermalink\HeadingPermalinkExtension::class,
        // Add e.g. smart punctuation:
        \League\CommonMark\Extension\SmartPunct\SmartPunctExtension::class,
    ],

    'highlight_theme' => [
        'light' => 'github-light',
        'dark' => 'github-dark',
    ],

    'commonmark_options' => [
        'heading_permalink' => [
            'insert' => 'none',
            'apply_id_to_heading' => true,
            'id_prefix' => '',
            'fragment_prefix' => '',
        ],
    ],
],
```

Each entry in `extensions` is a fully-qualified class name implementing `League\CommonMark\Extension\ExtensionInterface`; Lemme instantiates it per render. Pass any extension-specific configuration through `commonmark_options`.

Usage
-----

[](#usage)

### Creating Documentation

[](#creating-documentation)

1. **Create Markdown files** in your configured docs directory (default: `docs/`)
2. **Add frontmatter** to set page metadata (optional):

```
---
title: Getting Started
description: Learn how to get started with our project
slug: custom-getting-started
---

# Getting Started

Your content here...
```

#### Slug Configuration

[](#slug-configuration)

Slugs determine the URL path for your documentation pages:

- **Custom slugs**: Set a custom `slug` in the frontmatter to override the default
- **Auto-generated slugs**: When no slug is provided, Lemme automatically generates one from the filename:
    - Converts to `kebab-case` format
    - Removes number prefixes (e.g., `1_`, `2-`, `10_`)
    - Excludes directory names (only uses the filename)

All URL examples below assume the default route prefix (`/docs`). Adjust paths if you change or remove the prefix.

**Examples:**

```
 docs/1_getting-started/2_installation.md
 ├─ Default slug: "installation"
├─ URL: /installation

 docs/api/3-authentication.md
├─ Default slug: "authentication"
├─ URL: /authentication

 docs/guides/advanced-features.md
├─ Default slug: "advanced-features"
├─ URL: /advanced-features

```

**Custom slug example:**

```
---
title: Installation Guide
slug: setup
---
```

Result: `/setup` instead of `/installation`

##### Index Pages & Nested Index Behavior

[](#index-pages--nested-index-behavior)

Special handling applies to `index.md` files:

- Root `docs/index.md` becomes the "home" page and gets an empty slug (served at the docs root).
- A nested `index.md` (e.g. `docs/guide/index.md`) adopts the **directory name** (`guide`) as its slug instead of `index`.
- Number prefixes on the directory (e.g. `1_guide/index.md`) are stripped before generating the slug: `1_guide/index.md` -> `guide`.
- Regular files still derive their slug from their own filename only (directories are never prefixed onto slugs except for the nested index rule above).

This keeps URLs short and predictable: `docs/guide/index.md` -> `/docs/guide`, `docs/guide/intro.md` -> `/docs/intro` (note: prefix included). Only root `index.md` is served at `/docs` itself.

##### Duplicate Slug Handling

[](#duplicate-slug-handling)

If two files would produce the same slug (e.g. `docs/one/foo.md` and `docs/two/foo.md`) Lemme throws a runtime exception during page collection. Fix by either:

1. Adding a unique `slug:` value in one file's frontmatter, or
2. Renaming one of the files.

Fail‑fast detection prevents silently colliding pages and unexpected content swaps.

##### Quick Reference Summary

[](#quick-reference-summary)

CaseExample PathGenerated SlugExample URL (default prefix)Root index`docs/index.md``` (empty)`/docs`Nested index`docs/guide/index.md``guide``/docs/guide`Numbered nested index`docs/1_guide/index.md``guide``/docs/guide`Regular file`docs/guide/intro.md``intro``/docs/intro`CamelCase filename`docs/CamelCaseFile.md``camel-case-file``/docs/camel-case-file`With frontmatter slug`slug: custom``custom``/docs/custom`Collision (two foo.md)`one/foo.md`, `two/foo.md`Error–---

3. **Organize in folders** for better structure:

```
docs/
├── index.md
├── getting-started/
│   ├── installation.md
│   └── configuration.md
├── guides/
│   ├── deployment.md
│   └── troubleshooting.md
└── api/
    ├── authentication.md
    └── endpoints.md

```

### Directory-based Navigation Grouping

[](#directory-based-navigation-grouping)

Lemme automatically organizes your navigation based on your directory structure. Each folder becomes a group in the sidebar navigation:

- **Root files** (like `index.md`) appear ungrouped at the top
- **Folder-based files** are grouped under collapsible sections
- **Nested folders** create sub-groups for better organization

**Example Structure:**

```
docs/
├── index.md                    # Ungrouped: "Home"
├── 1_getting-started/          # Group: "Getting Started" (sorted first)
│   ├── 1_installation.md       #   ├─ Installation
│   └── 2_configuration.md      #   └─ Configuration
└── 2_api/                      # Group: "API" (sorted second)
    ├── 1_authentication.md     #   ├─ Authentication
    ├── 2_endpoints.md          #   ├─ Endpoints
    └── 3_advanced/             #   └─ Advanced (sub-group)
        ├── 1_webhooks.md       #       ├─ Webhooks
        └── 2_rate-limiting.md  #       └─ Rate Limiting

```

**Number Prefixes for Sorting:**

- Use `1_`, `2_`, `10_` or `1-`, `2-`, `10-` prefixes for precise ordering
- Number prefixes are automatically removed from navigation titles
- Both `snake_case` and `kebab-case` naming conventions are supported
- Files and directories without numbers sort alphabetically after numbered ones

You can disable grouping in the configuration if you prefer a flat navigation structure.

### Accessing Documentation

[](#accessing-documentation)

By default, your documentation will be available at:

- **Route prefix (default)**: `https://yoursite.com/docs`
- **Subdomain**: `https://docs.yoursite.com` (set `route_prefix=null` and `subdomain=docs`)

Precedence: If both `subdomain` and `route_prefix` are set, the route prefix wins (a notice is logged) and subdomain routing is ignored.

### API Access (Optional)

[](#api-access-optional)

Lemme can expose JSON API endpoints for headless usage. These are **disabled by default**. Enable them explicitly via your `.env` or config:

```
LEMME_API_ENABLED=true

```

Or set `config(['lemme.api.enabled' => true])` at runtime (e.g. inside a feature flag). Paths depend on your routing mode:

ModeIndex EndpointPage EndpointRoute prefix (`docs`)`/docs/api``/docs/api/{slug}`Custom prefix (`handbook`)`/handbook/api``/handbook/api/{slug}`Subdomain (`docs.`)`https://docs.yoursite.com/api``https://docs.yoursite.com/api/{slug}`If disabled, hitting the endpoints returns 404 and named routes `lemme.api` / `lemme.api.page` are not registered.

**Example use cases when enabled:**

- Build custom documentation frontends
- Create mobile apps or SPAs
- Integrate with external tools or chatbots
- Generate documentation reports

### Commands

[](#commands)

CommandPurpose`php artisan lemme:install`Create docs directory + sample files; publish assets (forced)`php artisan lemme:install --force`Overwrite existing sample files if present`php artisan lemme:clear`Clear page, HTML and search caches`php artisan lemme:reindex`Rebuild page list & search; warm HTML (when cache enabled)`php artisan lemme:reindex --clear`Clear caches first, then rebuild and warm`php artisan lemme:publish`(Provided by package) Publish assets/views/config (interactive)Reindex is deploy‑safe; schedule it if you bulk update docs.

### Publishing Assets / Views / Config

[](#publishing-assets--views--config)

Publish only what you need:

```
php artisan vendor:publish --tag=lemme-config
php artisan vendor:publish --tag=lemme-views
php artisan vendor:publish --tag=lemme-assets

```

Force re‑publish (e.g. after updating the package):

```
php artisan lemme:publish --force

```

### Cache & Reindex Details

[](#cache--reindex-details)

Caching (when `lemme.cache.enabled=true`):

- Pages collection stored once under `lemme.pages` when first loaded.
- Each rendered HTML page cached under `lemme.html.{slug}.{modified_at}` (immutable snapshot).
- Pointer key `lemme.html.current.{slug}` tracks the active snapshot; previous snapshot key is removed on rotation.
- Search data cached under `lemme.search_data` (rebuilt with pages or on demand if missing).

Running `lemme:reindex` (without `--clear`) re-reads markdown and warms (builds) HTML only if caching is enabled. Unchanged HTML snapshots remain current; changed files receive new keys and prior snapshots are pruned.

### Heading Anchors

[](#heading-anchors)

All Markdown headings (`#` .. `######`) are assigned stable, URL‑friendly IDs after HTML rendering. Duplicate headings on the same page receive numeric suffixes (`overview`, `overview-2`, `overview-3`, ...). This enables reliable deep‑linking and on‑page navigation.

### Search Index

[](#search-index)

The search index stores:

- `title`
- `category` (top‑level directory or `General`)
- `url`
- `content` (plain‑text extraction of rendered Markdown)

You can optionally truncate indexed content via `lemme.search.max_content_length` (0 = unlimited). Example in `.env`:

```
LEMME_SEARCH_MAX_CONTENT_LENGTH=8000

```

### Troubleshooting Slugs

[](#troubleshooting-slugs)

- Unexpected empty slug? Likely the root `index.md`.
- Got an exception about a duplicate slug? Provide a custom frontmatter slug or rename the file.
- Want to keep nested `index.md` as `index`? Add `slug: index` to its frontmatter (be sure it won’t collide with another page).

### Using the Facade

[](#using-the-facade)

You can also interact with Lemme programmatically:

```
use Ranetrace\\Lemme\Facades\Lemme;

// Get all documentation pages
$pages = Lemme::getPages();

// Get a specific page
$page = Lemme::getPage('getting-started');

// Get navigation structure
$navigation = Lemme::getNavigation();

// Clear cache
Lemme::clearCache();
```

Themes
------

[](#themes)

Lemme comes with a beautiful default theme built with Tailwind CSS 4. The theme features:

- Clean, modern design
- Responsive layout
- Mobile-friendly navigation
- Syntax highlighting for code blocks
- Automatic page navigation
- Search-friendly structure

The syntax highlighting is powered by **Shiki** and supports:

- PHP, JavaScript, Python, Ruby, Go, Rust
- HTML, CSS, SCSS, JSON, YAML, XML
- Bash, SQL, Docker, and many more!

Simply use triple backticks with the language identifier:

```
```php

```
```

Performance
-----------

[](#performance)

Lemme includes built-in caching to ensure your documentation loads quickly:

- Pages are cached automatically
- Cache respects file modification times
- Easy cache clearing via command or facade
- Configurable cache TTL

Subdomain Setup (Optional)
--------------------------

[](#subdomain-setup-optional)

By default, Lemme serves documentation at `/docs` on your main domain. To use subdomain routing instead (e.g., `docs.yoursite.com`):

1. **Configure DNS**: Add a CNAME record pointing `docs` to your main domain
2. **Set up web server**: Configure your web server to handle the subdomain
3. **Update config**: Set `LEMME_SUBDOMAIN=docs` and `LEMME_ROUTE_PREFIX=null` in your `.env` file

For Apache, add to your virtual host:

```
ServerAlias docs.yoursite.com
```

For Nginx:

```
server_name yoursite.com docs.yoursite.com;
```

Development
-----------

[](#development)

If you're contributing to Lemme or want to customize the styles:

### Building Assets

[](#building-assets)

```
# Install dependencies
bun install

# Build for development (with watching)
bun run dev

# Build for production
bun run build
```

The compiled CSS will be generated in the `dist/` directory and can be published to Laravel projects.

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

[](#contributing)

Contributions are welcome! Please feel free to submit a Pull Request.

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

Credits
-------

[](#credits)

- **Author**: Rutger Broerze
- **Built with**: Laravel, Tailwind CSS, Alpine.js
- **Markdown parsing**: Spatie Laravel Markdown (with Shiki syntax highlighting)
- **Frontmatter parsing**: Spatie YAML Front Matter

###  Health Score

43

—

FairBetter than 90% of packages

Maintenance83

Actively maintained with recent releases

Popularity12

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity60

Established project with proven stability

 Bus Factor1

Top contributor holds 100% 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 ~29 days

Recently: every ~1 days

Total

10

Last Release

37d ago

Major Versions

v1.0.1 → v2.02026-02-02

v2.0 → v3.02026-03-26

### Community

Maintainers

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

---

Top Contributors

[![ruerdev](https://avatars.githubusercontent.com/u/25254145?v=4)](https://github.com/ruerdev "ruerdev (74 commits)")

---

Tags

cachingdeveloper-toolsdocsdocumentationlaravellaravel-packagelivewiremarkdownsearchshikistatic-site-generatorsyntax-highlightingtailwindcsslaraveldocumentationgeneratormarkdownwebsitedocslemmeranetrace

###  Code Quality

TestsPest

Static AnalysisPHPStan

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/ranetrace-lemme/health.svg)

```
[![Health](https://phpackages.com/badges/ranetrace-lemme/health.svg)](https://phpackages.com/packages/ranetrace-lemme)
```

###  Alternatives

[binarytorch/larecipe

Generate gorgeous recipes for your Laravel applications using MarkDown

2.5k2.8M17](/packages/binarytorch-larecipe)[tightenco/jigsaw

Simple static sites with Laravel's Blade.

2.3k449.3k30](/packages/tightenco-jigsaw)[venturedrake/laravel-crm

A free open source CRM built as a package for laravel projects

42010.0k](/packages/venturedrake-laravel-crm)[riclep/laravel-storyblok

A Laravel wrapper around the Storyblok API to provide a familiar experience for Laravel devs

6277.0k5](/packages/riclep-laravel-storyblok)[dniccum/nova-documentation

A Laravel Nova tool that allows you to add markdown-based documentation to your administrator's dashboard.

37118.9k](/packages/dniccum-nova-documentation)[tomshaw/electricgrid

A feature-rich Livewire package designed for projects that require dynamic, interactive data tables.

119.2k](/packages/tomshaw-electricgrid)

PHPackages © 2026

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