artarts36/laravel-env-documentator

Laravel Environment Documentator

0.1.1 2022-01-25 01:52 UTC

Requires

• php: ^8.0
• artarts36/ci-git-sender: ^0.1
• artarts36/env-editor: ^1.2
• illuminate/console: ^8
• illuminate/support: ^8
• squizlabs/php_codesniffer: ^3.6

Requires (Dev)

• orchestra/testbench: *

MIT

• ArtARTs36

README

This package provides generate documentation about your app environment.

See example on default laravel environment

✔ Installation

Run commands:

• composer require --dev artarts36/laravel-env-documentator
• php artisan vendor:publish --provider="ArtARTs36\LaravelEnvDocumentator\Providers\EnvDocumentatorServiceProvider" --tag=config

☆ Usage

This package provides one console command.

» Use in Local

Run command for generate by default (.env.example): php artisan env:doc docs/environment.md

Or: php artisan env:doc docs/environment.md --env-path=specify.env

» Use in CI

Setup git settings in config file env_documentator.php

Run command for generate docs by default (.env.example): php artisan env:doc docs/environment.md --ci

Or: php artisan env:doc docs/environment.md --env-path=specify.env --ci