PHP API

The Laradocs\Facades\Laradocs facade exposes the core service. Use it in service providers, console commands, or anywhere else you need to read or manipulate the docs tree at runtime.

#Variables and macros

use Laradocs\Facades\Laradocs;

Laradocs::variables(['version' => '1.0.0']);   // merge static values
Laradocs::variables(fn () => [                  // deferred until render
    'user_count' => \App\Models\User::count(),
]);

Laradocs::share('year', date('Y'));             // register a single value

Laradocs::macro('tweet', fn (array $args) => /* ... */);

See Variables and Macros for full coverage.

#Querying the document tree

$all   = Laradocs::all();    // Laradocs\Documents\DocumentCollection
$tree  = Laradocs::tree();   // Laradocs\Documents\DocumentTree
$home  = Laradocs::home();   // Laradocs\Documents\Document|null
$page  = Laradocs::find('guide/routing'); // Document|null
$html  = Laradocs::render($page);          // cached rendered HTML

#DocumentCollection

A typed Illuminate\Support\Collection<int, Document> with a couple of extras:

#DocumentTree

The navigation tree, built from the collection:

#Document and Metadata

A document exposes:

• $document->slug — the resolved URL slug.
• $document->title() — title with filename fallback.
• $document->html — the rendered HTML (only present after render()).
• $document->metadata — typed Metadata object.
• $document->metadata->get('key', $default) — read any custom field.

#Variable values

$values = Laradocs::variableValues();
// ['version' => '1.0.0', 'user_count' => 42, ...]

Closures registered with Laradocs::variables(fn () => …) are evaluated exactly once per request.

#Internal services

These exist if you need them but most users won't reach for them:

• Laradocs::variableRegistry(): VariableRegistry
• Laradocs::macroRegistry(): MacroRegistry
• Laradocs::cache(): DocumentCache