laravel-docit

Customization

Create a docit.json file in your project root to customize the docs site.

Site identity

{
  "siteName": "My Project",
  "githubUrl": "https://github.com/username/repo",
  "editBaseUrl": "https://github.com/username/repo/edit/main"
}

siteName and githubUrl are auto-detected from your project's composer.json if not set explicitly. siteName uses the package name (the part after the vendor prefix in name). githubUrl uses support.source first, falling back to homepage when not set.

{
  "order": ["index", "installation", "quick-start", "customization"],
  "labels": {
    "index": "Guide",
    "installation": "Installation",
    "quick-start": "Quick Start",
    "customization": "Customization"
  }
}

Custom containers (cards)

Use card and `` for card layouts:


- **[Installation](/installation)** – Composer or monorepo. Add the `docit` script and run `composer docit`.


- **[Quick Start](/quick-start)** – Build, configure output dir, and deploy.
  • card Title url – A single card. Optional url makes the card a link.
  • `` – Wraps cards in a responsive grid (2 cols on sm, 3 on lg).