Configuration

Publish the config file:

bash

php artisan vendor:publish --tag=laradocs-config

It lands at config/laradocs.php. Every important value is also driven by an environment variable so you can change behaviour per-environment without editing PHP.

Master switch

Option	Env	Default
`enabled`	`LARADOCS_ENABLED`	`true`

When false, no routes are registered and every docs URL returns 404.

Routes

Option	Env	Default
`route.prefix`	`LARADOCS_ROUTE_PREFIX`	`docs`
`route.domain`	`LARADOCS_ROUTE_DOMAIN`	`null`
`route.middleware`	—	`['web']`
`route.name`	`LARADOCS_ROUTE_NAME`	`laradocs.`

middleware accepts any Laravel middleware aliases or class names. Use it to gate docs behind auth in non-public projects.

Warning

Route prefix and domain are read at boot. After changing them, clear your route cache with php artisan route:clear.

Documents

Option	Env	Default
`docs.path`	`LARADOCS_PATH`	`base_path('docs')`
`docs.extensions`	—	`['md', 'markdown']`
`docs.ignored_patterns`	—	`['.*', '_drafts', 'README.md']`
`docs.index`	—	`_index`

ignored_patterns uses fnmatch syntax. docs.index controls the filename treated as a section landing page (so guide/_index.md serves /docs/guide).

Routing strategy

Option	Env	Default
`routing.strategy`	`LARADOCS_ROUTING_STRATEGY`	`both`
`routing.fallback`	—	`filename`

Strategy	Behaviour
`filename`	Slug from the file path only.
`metadata`	Slug from front-matter `slug:`, falling back to `routing.fallback`.
`both`	Front-matter `slug:` wins when present, otherwise the filename.

Metadata defaults

php

'metadata' => [
    'default' => [
        'order'  => 999,
        'hidden' => false,
    ],
],

These supply values when a page omits them.

Parser

Option	Env	Default
`parser.extensions.gfm`	—	`true`
`parser.extensions.attributes`	—	`true`
`parser.extensions.footnotes`	—	`true`
`parser.extensions.callouts`	—	`true`
`parser.extensions.heading_anchors`	—	`true`
`parser.extensions.images`	—	`true`
`parser.extensions.video`	—	`true`
`parser.extensions.mermaid`	—	`true`
`parser.extensions.variables`	—	`true`
`parser.extensions.icons`	—	`true`
`parser.extensions.macros`	—	`true`
`parser.mermaid.src`	`LARADOCS_MERMAID_SRC`	jsDelivr mermaid@11 ESM
`parser.highlighter`	`LARADOCS_HIGHLIGHTER`	`shiki-css`
`parser.unknown_variable`	—	`blank`
`parser.toc.min_level`	—	`2`
`parser.toc.max_level`	—	`3`
`parser.toc.min_headings`	—	`2`

unknown_variable controls how {{ undefined_key }} renders: blank leaves nothing, raw keeps the literal braces. The TOC only renders when a page has at least min_headings headings inside the level range.

See Rich Content for what each extension enables.

Icons

Option	Env	Default
`icons.driver`	`LARADOCS_ICONS_DRIVER`	`heroicons`
`icons.heroicons.path`	`LARADOCS_HEROICONS_PATH`	auto-detect
`icons.heroicons.variant`	`LARADOCS_HEROICONS_VARIANT`	`outline`

icons.driver sets the default icon set used by @icon('name') and @docs('icon', 'name'). The built-in set is heroicons; set to null to disable automatic rendering entirely. The heroicons set requires npm install heroicons — the package is auto-detected under node_modules/heroicons/. Set heroicons.path to an absolute path when it lives elsewhere.

See Icons for the full guide including custom sets.

UI

Option	Env	Default
`ui.theme`	`LARADOCS_THEME`	`auto`
`ui.preset`	`LARADOCS_UI_PRESET`	`classic`
`ui.accent`	`LARADOCS_ACCENT`	`#FF2D20`
`ui.webfonts`	—	`true`
`ui.fonts.sans`	`LARADOCS_FONT_SANS`	`null`
`ui.fonts.mono`	`LARADOCS_FONT_MONO`	`null`
`ui.brand.title`	`LARADOCS_TITLE`	`Documentation`
`ui.brand.tagline`	`LARADOCS_TAGLINE`	`null`
`ui.brand.logo`	`LARADOCS_LOGO`	`null`
`ui.brand.favicon`	`LARADOCS_FAVICON`	`null`
`ui.header.links`	—	`[]`
`ui.sidebar.collapsible`	—	`true`
`ui.sidebar.show_root`	—	`true`
`ui.footer.enabled`	`LARADOCS_FOOTER`	`true`
`ui.footer.text`	`LARADOCS_FOOTER_TEXT`	`null`
`ui.footer.links`	—	`[]`
`ui.banner.enabled`	`LARADOCS_BANNER`	`false`
`ui.banner.type`	`LARADOCS_BANNER_TYPE`	`info`
`ui.banner.message`	`LARADOCS_BANNER_MESSAGE`	`null`
`ui.edit.url`	`LARADOCS_EDIT_URL`	`null`
`ui.last_updated_source`	`LARADOCS_LAST_UPDATED_SOURCE`	`front_matter`
`ui.search.enabled`	`LARADOCS_SEARCH`	`true`

See Customising the UI for what each value does visually.

Localisation

Option	Env	Default
`locale.default`	`LARADOCS_LOCALE`	`en`
`locale.available`	—	`['en' => 'English']`
`locale.selector`	`LARADOCS_LOCALE_SELECTOR`	`true`
`locale.date_format`	`LARADOCS_DATE_FORMAT`	`jS F Y`

The bundled views are fully translatable. See Localisation for the workflow — publishing the language files, adding locales and the in-page language selector.

Analytics

Option	Env	Default
`analytics.fathom.site`	`LARADOCS_FATHOM_SITE`	`null`
`analytics.fathom.script`	`LARADOCS_FATHOM_SCRIPT`	`https://cdn.usefathom.com/script.js`
`analytics.fathom.spa`	`LARADOCS_FATHOM_SPA`	`null`
`analytics.google.measurement_id`	`LARADOCS_GA_MEASUREMENT_ID`	`null`
`analytics.google.anonymize_ip`	`LARADOCS_GA_ANONYMIZE_IP`	`false`

Set the identifier to enable a provider — leave it null to opt out. See Analytics for details.

SEO

Option	Env	Default
`seo.enabled`	`LARADOCS_SEO`	`true`
`seo.site_name`	`LARADOCS_SEO_SITE_NAME`	`ui.brand.title`
`seo.title_suffix`	`LARADOCS_SEO_TITLE_SUFFIX`	`· {site_name}`
`seo.description`	`LARADOCS_SEO_DESCRIPTION`	`ui.brand.tagline`
`seo.auto_description`	`LARADOCS_SEO_AUTO_DESCRIPTION`	`true`
`seo.image`	`LARADOCS_SEO_IMAGE`	`null`
`seo.author`	`LARADOCS_SEO_AUTHOR`	`null`
`seo.twitter`	`LARADOCS_SEO_TWITTER`	`null`
`seo.type`	`LARADOCS_SEO_TYPE`	`article`
`seo.robots`	`LARADOCS_SEO_ROBOTS`	package default
`seo.schema.article`	`LARADOCS_SEO_SCHEMA_ARTICLE`	`true`
`seo.schema.breadcrumbs`	`LARADOCS_SEO_SCHEMA_BREADCRUMBS`	`true`

Rich meta tags, Open Graph / Twitter cards and JSON-LD are generated for every page automatically; these tune the site-wide defaults. See SEO.

Cache

Option	Env	Default
`cache.enabled`	`LARADOCS_CACHE`	`true`
`cache.store`	`LARADOCS_CACHE_STORE`	`null` (default store)
`cache.ttl`	`LARADOCS_CACHE_TTL`	`86400`
`cache.key_prefix`	—	`laradocs`

See Caching.

Variables and macros

php

'variables' => [
    'version' => '1.0.0',
],

'macros' => [
    // 'my-macro' => 'partials.my-macro',
],

See Variables and Macros.

Disabling docs in production

dotenv

LARADOCS_ENABLED=false

All docs routes return 404 instantly — useful when shipping early builds where the docs aren't ready for public consumption.

#Master switch

#Routes

#Documents

#Routing strategy

#Metadata defaults

#Parser

#Icons

#UI

#Localisation

#Analytics

#SEO

#Cache

#Variables and macros

#Disabling docs in production