Skip to content
minidoc
PHP CSS
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples
src
.gitignore
README.md
composer.json
composer.lock

README.md

Minidoc

Установка

$ composer require --dev kosuha606/minidoc

Quick Start

Инструмент для быстрого сбора документации из аннтоаций классов в проекте.

Пример вывода документации:

<?php
echo (new DocsBuilder())
    ->addParseParam('category')
    ->addParseParam('description')
    ->addParseParam('version')
    ->addClassRegexp('/classes/')
    ->addPreloadClassesDir(__DIR__.'/classes')
    ->buildTemplate()
;

Пример работы

alt text

Настройка

Добавить стили или скритпы в шаблон:

$docsBuilder->addStyle(new ResourceDTO(__DIR__.'/resources/style.css', ResourceDTO::TYPE_FILE));
$docsBuilder->addScript(new ResourceDTO(__DIR__.'/resources/script.js', ResourceDTO::TYPE_FILE));

Отрендерить свой шаблон документации:

$docsBuilder->setViewTemplate(__DIR__.'/views/main.php');

Добавтиь свои параметры для парсинга в аннотациях:

$docsBuilder->setParseParams(['category', 'description']);
$docsBuilder->addParseParam('mark');

Настроить предзагрузку классов путем передачи пути к директории с классами:

$docsBuilder->addPreloadClassesDir(__DIR__.'/../../../../contexts');

Обработать данные после их построения

$docBuilder->afterBuildData(function() {});

Установить регулярное выражение для выбора файлов из указанной директории

$docBuilder->setFilesRegexp();
You can’t perform that action at this time.