https://github.com/horstoeko/multidocumentor

Multiformat Documentation Creator
https://github.com/horstoeko/multidocumentor

Last synced: 4 months ago
JSON representation

Multiformat Documentation Creator

• Host: GitHub
• URL: https://github.com/horstoeko/multidocumentor
• Owner: horstoeko
• License: mit
• Created: 2023-01-29T09:57:37.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2023-10-01T08:18:28.000Z (over 2 years ago)
• Last Synced: 2025-01-10T17:30:05.886Z (12 months ago)
• Language: PHP
• Size: 2.19 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Multi Format Documentation Creator

[![Latest Stable Version](https://poser.pugx.org/horstoeko/multidocumentor/v/stable.png)](https://packagist.org/packages/horstoeko/multidocumentor) [![Total Downloads](https://poser.pugx.org/horstoeko/multidocumentor/downloads.png)](https://packagist.org/packages/horstoeko/multidocumentor) [![Latest Unstable Version](https://poser.pugx.org/horstoeko/multidocumentor/v/unstable.png)](https://packagist.org/packages/horstoeko/multidocumentor) [![License](https://poser.pugx.org/horstoeko/multidocumentor/license.png)](https://packagist.org/packages/horstoeko/multidocumentor) [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/horstoeko/multidocumentor)

A simple Multi-Format Documentation Creator Library

With `horstoeko/multidocumentor` you can create an API documentation of any package/library in several output formats-

This package makes use of

  * [MPDF by Matěj Humpál and Ian Back](https://github.com/mpdf/mpdf)

  * [Twig Template Engine by Armin Ronacher and Fabien Potencier](https://twig.symfony.com/)

  * [ParseDown by Emanuil Rusev](https://github.com/erusev/parsedown)

  * [phpDocumentor ReflectionDocBlock by Mike van Riel and Jaap van Otterdijk](https://github.com/phpDocumentor/ReflectionDocBlock)

  * [Laravel like standalone validation library by Muhammad Syifa](https://github.com/rakit/validation)

  * [Symfony Console by Fabien Potencier](https://github.com/symfony/console)

  * [Symfony Finder by Fabien Potencier](https://github.com/symfony/finder)

  * [HTML-to-markdown conversion helper by Colin O'Dell and Nick Cernis](https://github.com/thephpleague/html-to-markdown)

## Installation

There is one recommended way to install `horstoeko/multidocumentor` via [Composer](https://getcomposer.org/):

* adding the dependency to your ``composer.json`` file:

```js

  "require": {

      ..

      "horstoeko/multidocumentor":"^1",

      ..

  },

```