lumadoc/lumadoc

Latte UI documentation generator.

dev-master 2024-11-06 08:39 UTC

Requires

• php: 5.6 - 8.3
• latte/latte: ^2.4
• nette/finder: ^2.4 || ^3.0

Requires (Dev)

• nette/http: ^2.4 || ^3.0
• nette/tester: ^2.0

Suggests

• nette/http: For Lumadoc\HttpController

BSD-3-Clause

• Jan Pecha

README

Latte UI documentation generator.

Installation

Download a latest package or use Composer:

composer require lumadoc/lumadoc

LumaDoc requires PHP 5.6.0 or later.

Usage

Create & setup your documentation entrypoint (path/to/docs/index.php)

<?php

declare(strict_types=1);

require __DIR__ . '/vendor/autoload.php';

// settings
$lumadoc = new Lumadoc\Lumadoc(
	new Lumadoc\Settings(
		docName: 'My Doc Name',
		sections: [
			new Lumadoc\Section('section1', 'Section One'),
			new Lumadoc\Section('section2', 'Section Two'),
			new Lumadoc\Section('blog', 'Blog'),
		],
		directory: __DIR__,
		assetsBaseUrl: '/assets/',
		installationBaseUrl: 'https://cdn.example.com/assets/'
	),
	latte: $latteEngine
);

// controller
$httpController = new Lumadoc\HttpController($lumadoc);
$httpController->run(
	$httpRequest,
	$httpResponse
);

This setup requires nette/http package:

composer require nette/http

Create documentation files

Start webserver (for local development)

php -S localhost:8000 path/to/docs-dir

License: New BSD License
Author: Jan Pecha, https://www.janpecha.cz/