osflab/doc-maker

OSF document generator

3.0.0 2018-02-26 14:34 UTC

Requires

• php: ^7.1.0
• erusev/parsedown: 1.6.4
• osflab/container: ~3.0.0
• osflab/exception: ~3.0.0
• osflab/stream: ~3.0.0

Requires (Dev)

• osflab/test: ~3.0.0

Suggests

• osflab/view: ~3.0.0

AGPL-3.0-or-later

• Guillaume Ponçon

README

Document generator based on markup langages, including Markdown.

Installation

You need at least php 7.1 and composer:

sudo apt install composer

In your application via composer

This is the recommended way to use this feature in a non-osf project.

Just add osflab/doc-maker in your composer.json file.

From github

To test the component or participate in its development.

git clone https://github.com/osflab/doc-maker.git
cd doc-maker && composer update

Unit tests launch:

vendor/bin/runtests