Click the Castor logo or press Ctrl Alt T to change theme.
# Getting started Castor Docs is intended to be installed as a development dependency in each Castor package. Castor packages are published in the Castor Composer repository, not Packagist. Add the repository first: ```json { "repositories": [ { "type": "composer", "url": "https://castor-labs.github.io/php-packages" } ] } ``` Then require the generator: ```bash composer require --dev castor-labs/docs ``` Then create a `.dev/docs` directory and generate the static output: ```bash vendor/bin/castor-docs generate --source=.dev/docs --target=.dev/docs-dist ``` ## Requirements The generator requires PHP 8.3 or later. It has no runtime Composer dependencies beyond PHP itself. The generated HTML intentionally uses client-side libraries from CDNs for Markdown rendering, sanitization, syntax highlighting, and search behaviour. ## Source layout A minimal documentation source looks like this: ```text .dev/docs/ config.php index.md pages/ index.md guides/ index.md conventions.md ``` `index.md` becomes the root landing page. Files under `pages` become documentation routes under `/docs`.
Castor ecosystem