CLI

Laradocs registers these Artisan commands. Run any of them with php artisan {name}.

#docs:check

php artisan docs:check [--json]

Walks the entire docs tree and reports:

• Broken internal links — markdown links whose resolved slug does not match any loaded document (e.g. [text](/docs/missing-page)).
• Orphaned pages — documents that are unreachable: absent from the navigation tree (i.e. hidden) and not the target of any internal link from another page. Visible pages always appear in the auto-generated navigation, so the orphans surfaced here are hidden pages that nothing links to — dead content you can reach by neither the menu nor a cross-reference.
• Redirect cycles — chains of redirect: front-matter that loop back to an earlier slug (e.g. a → b → a). Only redirects whose target is a known slug are followed, so a dangling redirect never produces a false positive.

The command exits with a non-zero status whenever any finding is found, making it suitable for use in CI pipelines.

Pass --json to receive a structured JSON report instead of formatted output:

php artisan docs:check --json

{
  "broken_links": [
    { "source": "guide/intro", "href": "/docs/missing", "slug": "missing" }
  ],
  "orphans": [],
  "redirect_cycles": [
    { "cycle": ["old-page", "new-page", "old-page"] }
  ],
  "summary": {
    "broken_links": 1,
    "orphans": 0,
    "redirect_cycles": 1,
    "total": 2
  }
}

#Fixture coverage

The test suite exercises the following scenarios for docs:check:

#docs:lint

php artisan docs:lint [--json]

Validates the front-matter and icon usage of every document and reports five categories of problem:

• Missing required fields — any field listed in laradocs.lint.required that is absent or empty. Defaults to ['title']; add any front-matter key you want to enforce (e.g. description, author, updated_at).
• Slug collisions — two or more documents that resolve to the same URL slug, whether from a path-derived slug or an explicit slug: front-matter override.
• Unknown layout names — when laradocs.lint.layouts is non-empty, any layout: value that is not in that allowlist. An empty list disables the check entirely.
• Invalid updated_at formats — a present updated_at value that cannot be parsed as a recognised date or datetime. Accepted formats: YYYY-MM-DD, YYYY-MM-DD HH:MM:SS, YYYY-MM-DDTHH:MM:SS, and YYYY-MM-DDTHH:MM:SS+HH:MM.
• Unresolved icons — an icon: front-matter value or an inline @icon() call that does not resolve to an SVG. This surfaces a missing icon dependency: the built-in heroicons set is only available once its npm package is installed, so a deployment that uses icons without it would otherwise render nothing silently. The finding distinguishes an unavailable set (with an npm install heroicons hint) from an unknown icon name. Calls inside code blocks are ignored. Disable with laradocs.lint.icons => false. See Icons.

The command exits with a non-zero status whenever any finding is reported, making it suitable for CI pipelines.

Pass --json to receive a structured report instead of formatted output:

php artisan docs:lint --json

{
  "missing_fields": [
    { "slug": "guide/intro", "path": "guide/intro.md", "field": "title" }
  ],
  "slug_collisions": [
    { "slug": "intro", "paths": ["intro.md", "sub/intro.md"] }
  ],
  "unknown_layouts": [
    { "slug": "landing", "path": "landing.md", "layout": "ghost" }
  ],
  "invalid_dates": [
    { "slug": "guide/intro", "path": "guide/intro.md", "value": "March 2026" }
  ],
  "unresolved_icons": [
    { "slug": "guide/intro", "path": "guide/intro.md", "icon": "arrow-long-right", "set": "heroicons", "reason": "set_unavailable" }
  ],
  "summary": {
    "missing_fields": 1,
    "slug_collisions": 1,
    "unknown_layouts": 1,
    "invalid_dates": 1,
    "unresolved_icons": 1,
    "total": 5
  }
}

#Configuration

The linter is configured under the lint key in config/laradocs.php:

'lint' => [
    // Fields every document must declare. Use the YAML key name.
    'required' => ['title'],

    // Allowlist of valid layout names. Empty = skip the layout check.
    'layouts' => [],

    // Validate that referenced icons resolve to an SVG. Set false to skip
    // (e.g. in CI environments without node_modules).
    'icons' => true,
],

To enforce additional required fields across your whole docs tree, extend the list:

'required' => ['title', 'description', 'updated_at'],

To restrict which layouts documents may use, set an explicit allowlist:

'layouts' => ['docs', 'landing', 'changelog'],

#Fixture coverage

#laradocs:install

php artisan laradocs:install [--force]

Publishes config/laradocs.php, ensures docs.path exists, and writes a starter index.md if one isn't already there. Pass --force to overwrite an existing config or starter page.

#make:doc

php artisan make:doc {name} \
    [--title=...] [--group=...] [--order=...] [--force]

Scaffolds a new markdown file inside your docs directory. name is the slug-style path you want (e.g. guide/installation or reference/migration.md — the extension is optional).

The output is produced from a Blade stub you can publish and edit — see Customising stubs.

#laradocs:lang

php artisan laradocs:lang {locale} [--translate] [--force]
php artisan laradocs:lang --list

Scaffolds a translation file for a new locale, or lists the locales that are available. A natural companion to laradocs:install and make:doc.

#Scaffolding a locale

php artisan laradocs:lang fr

Creates lang/vendor/laradocs/fr/laradocs.php using the best available source:

1. The package's own bundled translation for that locale (e.g. de, es, it, nl, sv).
2. Your published lang/vendor/laradocs/en/laradocs.php (if present), so any customisations to the English strings carry over.
3. The package's bundled English file as a fallback.

Pass --force to overwrite a file that already exists.

#Interactive translation

Pass --translate to translate each string immediately after the file is created:

php artisan laradocs:lang fr --translate

The command walks through every key one at a time, showing the original value as the default. Press Enter to keep the original and move on; type a new value to replace it. Press Backspace on an empty prompt to step back and revise the previous string.

When --translate is omitted and the command is run in an interactive terminal, it asks whether you'd like to translate now (default: no). In non-interactive contexts (CI, piped input) the question is silently skipped.

#Listing locales

php artisan laradocs:lang --list

Prints a table showing which locales are bundled with the package and which have already been published to your application:

+--------+---------+-----------+
| locale | bundled | published |
+--------+---------+-----------+
| de     | yes     | no        |
| en     | yes     | yes       |
| es     | yes     | no        |
| fr     | no      | yes       |
+--------+---------+-----------+

#laradocs:cache

php artisan laradocs:cache

Pre-renders every visible document, warms the cache, stores the navigation tree, generates the sitemap, and rebuilds the search index. Hooked into Laravel's optimizer, so php artisan optimize calls it automatically.

#laradocs:index

php artisan laradocs:index

Builds the full-text search index and pushes it to the configured engine (a Scout backend, or the built-in JSON index). Run automatically as part of laradocs:cache; run it on its own to refresh just the index.

#laradocs:clear

php artisan laradocs:clear

Flushes all cached HTML, the navigation tree, the sitemap and the search index. Hooked into php artisan optimize:clear.