kalimahapps/daleel

PHP documentation markdown and API generator

1.0.7 2023-08-26 10:40 UTC

Requires

• php: ^8.1
• eftec/bladeone: ^4.9
• league/commonmark: ^2.4
• nikic/php-parser: ^4.16
• phpdocumentor/reflection: ^5.3
• phpdocumentor/reflection-common: ^2.2
• phpdocumentor/reflection-docblock: ^5.3
• phpdocumentor/type-resolver: ^1.7.2
• psr/log: ^3.0
• scrivo/highlight.php: v9.18.1.10
• symfony/console: ^6.3
• symfony/filesystem: ^6.3
• symfony/finder: ^6.3
• symfony/http-client: ^6.3
• symfony/process: ^6.3
• symfony/yaml: ^6.3

Requires (Dev)

• pestphp/pest: ^2.9

MIT

• Abdul Al-Hasany

• documentation
• phpdoc
• api
• markdown

README

Daleel

PHP documentation generator

Documentation

Documentation for Daleel can be found on the website.

Quick start

• Install through composer

composer require kalimahapps/daleel

• Create daleel.php in your working directory and add the following code to it:

<?php
use KalimahApps\Daleel\Config;

$config = Config::getInstance();
$config->defineConfig(
	// Configuration array
	array()
);

The minimum requirement for the configuration is to define the versions key.

Check the configuration section for more details.

• Build documentation

./vendor/bin/daleel build

Documentation will be generated in the build directory.

• View documentation

./vendor/bin/daleel serve

License

Daleel is open-sourced software licensed under the MIT license.