larecipe.json

Every key of larecipe.json, a doc set's manifest at the root of its content. It holds presentation and structure; infrastructure lives in config/larecipe.php, and secrets never belong here. Without the file, a set is named after its key, with one version and one language.

{
  "$schema": "https://larecipe.saleem.dev/schemas/3.x/larecipe.json",
  "name": "LaRecipe",
  "description": "Living documentation for Laravel apps. Your coding agents write the docs and keep them current; every reader, human or agent, gets the current answer.",
  "favicon": "/favicon.svg",
  "provenance": false,
  "repository": {
    "url": "https://github.com/saleem-hadad/larecipe",
    "docsUrl": "https://github.com/larecipe/larecipe-docs",
    "docsPath": "docs"
  },
  "versions": [
    {
      "id": "3.x",
      "default": true
    },
    {
      "id": "2.x",
      "status": "maintained"
    }
  ],
  "locales": [
    {
      "code": "en",
      "label": "English",
      "default": true
    },
    {
      "code": "ar",
      "label": "العربية",
      "dir": "rtl"
    }
  ],
  "inserts": {
    "article.after": [
      "Subscribe"
    ],
    "footer": [
      "Byline"
    ]
  },
  "agents": {
    "llmsTxt": {
      "description": "LaRecipe is the docs engine that lives inside your Laravel app: Markdown docs in your repo (or your database), served to people as a fast site and to agents as Markdown, llms.txt, skill.md and MCP, and kept current by your own coding agent in the same pull request as the code.",
      "instructions": "Read the 3.x pages unless the user is on LaRecipe 2. Commands are php artisan larecipe:*; configuration lives in config/larecipe.php, presentation in docs/larecipe.json. Prefer the Reference pages for exact option names."
    }
  }
}

Keys

repository

Most apps keep code and docs in one repository and set only url. This site keeps its docs in their own repository, so it sets docsUrl while the header still links to the package.

theme

versions

Each item is a version id as a string, or an object:

See versions.

locales

Each item is a locale code as a string, or an object:

See languages.

navbar

The header already shows repository.url as an icon, so a navbar link to the same URL is left out.

Navbar, footer and repository links must be http, https or mailto URLs, or paths on your site. Any other link is left out of every page, and larecipe:validate reports it as links.unsafe.

redirects

A redirect runs only when no page lives at from. On a versioned set, a from without a version applies in every version: /docs/setup matches /docs/3.x/setup and /docs/2.x/setup, and a to inside the set that names no version keeps the reader in their version. A from with a version matches that version only. larecipe:validate reports redirects that loop (redirects.loop) and redirects a page shadows (redirects.shadowed).

inserts

Keys are insert points: header.actions, sidebar.before, sidebar.after, article.before, article.after, toc.after and footer. Values are lists of component names in PascalCase. A page opts out with inserts in its frontmatter. See insert points.

integrations.analytics

Each tool's script goes on every page once its values match the shape its provider uses; a value that does not match is left out. Only a repository set reads integrations from larecipe.json. A database set ignores them (larecipe:validate warns with manifest.integrations): use sets.{key}.integrations.analytics in config/larecipe.php, which takes the same keys for every set and wins per tool.

See analytics.

agents

See agent surfaces.

Validation

larecipe:validate checks the file under the manifest.schema rule: invalid JSON and values that break the schema are errors, a missing larecipe.json is a warning, and a top-level key within two edits of a known one is a warning with the fix (Rename "theem" to "theme".). Other unknown top-level keys are kept, and a round trip through any source never loses them.

The schema

The schema ships with the package at resources/schemas/larecipe.schema.json. LaRecipe writes this $schema URL when it creates or upgrades a manifest, and it is the schema's $id:

https://larecipe.saleem.dev/schemas/3.x/larecipe.json

Every doc set also serves the schemas that match your installed version at /{prefix}/schemas/{name}.json, for larecipe, navigation, frontmatter and validate, with Content-Type: application/schema+json and Access-Control-Allow-Origin: * (/schemas/larecipe.json on this site):

The served path has no version segment and always matches your installed package. The versioned $id URL resolves too: this site serves /schemas/3.x/{name}.json, so an editor that follows $schema gets the file.

Next

• Configuration: the infrastructure side, in config/larecipe.php.
• Frontmatter: settings for one page.