Routing

Laradocs generates a URL for every document. The strategy is configurable via laradocs.routing.strategy:

• filename — the slug comes from the file path only.
• metadata — the slug comes from the front-matter slug: (falling back to routing.fallback, default filename).
• both (default) — metadata wins when present, otherwise the filename.

#Filename slugs

docs/guide/getting-started.md   ->  /docs/guide/getting-started
docs/api/_index.md              ->  /docs/api
docs/_index.md                  ->  /docs

A file named _index.md inside a folder is the section landing page; that filename is configurable via docs.index.

#Overriding with metadata

---

title: Authentication
slug: security/auth

---

This page is served at /docs/security/auth regardless of where the file lives on disk. Path-traversal slugs (../foo) are neutralised before resolution.

#Redirects

Set redirect: in front-matter to bounce visitors elsewhere — handy when you move or rename a page:

---

redirect: guide/routing

---

---

redirect: https://example.com/docs/new

---

Relative values resolve through route('laradocs.show', …) so they honour your route.prefix and route.domain. Absolute URLs are allowed through the URL safety guard (no javascript: or data:).

#Route prefix and domain

LARADOCS_ROUTE_PREFIX=docs
LARADOCS_ROUTE_DOMAIN=docs.example.com

LARADOCS_ROUTE_PREFIX="" mounts the docs at the application root — useful for dedicated docs sites — but be careful to register the package after your application's other routes so it doesn't shadow them.

#Middleware

// config/laradocs.php
'route' => [
    'middleware' => ['web', 'auth'],
],

Any middleware alias or FQCN works. Use this to gate internal docs behind an authenticated guard.

#Disabling docs

LARADOCS_ENABLED=false

When disabled, no routes are registered at all and every docs URL returns 404 — including the asset route.

#Asset route

The package serves its compiled CSS and JS from a route under your configured prefix:

/docs/_laradocs/asset/laradocs.css
/docs/_laradocs/asset/laradocs.js

There is no Cache-Control header on this route by default — attach your own caching middleware (or publish the assets with vendor:publish --tag=laradocs-assets) if you want to cache them.

#Named routes

All routes are registered under the laradocs. name prefix:

Use them via route('laradocs.show', ['path' => 'guide/routing']).