Skip to content

kalimahapps/daleel

Repository files navigation

Daleel

Daleel

PHP documentation generator

Latest Version Total Downloads Software License

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.