laravel-docit

Quick Start

1. Run the build

composer docit

Or run the bin file directly:

php vendor/bin/build-docs

For monorepo: php packages/laravel-docit/bin/build-docs

2. Output

The built site is written to DOCIT_OUTPUT_DIR (default docs/dist) in your project root. Set the env var to use a different location (e.g. docs, dist, build). Deploy via GitHub Actions or copy to any static host.

3. Content structure

DirectoryPurpose
docsDocumentation pages (Markdown)

Place your Markdown files in docs/ in the docit package (or your consuming package). Use docit.json in your project root to customize sidebar order and labels.

4. Customization

  • Site name & URL: Set via DOCIT_SITE_NAME and DOCIT_EDIT_BASE_URL env vars or in docit.json