Documentation generator for PHP projects
Open Issues: 0
- php: ^7.2
- cache/redis-adapter: ^1.0
- erusev/parsedown: ^1.7
- hanneskod/classtools: ~1.0
- illuminate/log: 5.8.*
- knplabs/github-api: ^2.11
- laravel-zero/framework: 5.8.*
- php-http/guzzle6-adapter: ^1.1
- phpdocumentor/reflection-docblock: 4.3
- mockery/mockery: ^1.0
- phpunit/phpunit: ^7.5
This package is auto-updated.
Last update: 2023-03-14 00:36:15 UTC
Lowdown will generate documentation with as much detail as you provide in the form of type hints and PHPDoc annotations or docblocks within your project.
All docblocks are run through a Markdown parser.
Lowdown pays special attention to functions and methods which include a
<pre></pre> block in the docblock.
Whatever is within the
<pre></pre> tag is deemed to be a code example.
The example is extracted and evaluated dynamically; the output is saved for inclusion in the documentation.
To further sweeten the deal, the example code can be posted to GitHub as a gist.
A link to run it as a Melody script is generated with the documentation.
Install the composer package into your project as a dev dependency:
composer require --dev datashaman/lowdown
Add environment variables to your .env to configure the build process. These are all optional.
LOWDOWN_DESTThe destination folder where documentation is written to. Defaults to docs/api.
LOWDOWN_GISTS_CACHEDGitHub Gist requests should be cached. Defaults to true.
LOWDOWN_GISTS_TOKENGitHub personal access token. Used for generating Gists.
LOWDOWN_GISTS_USERNAMEGitHub username. Used for generating Gists.
LOWDOWN_SOURCESThe source folders where documentation is generated from. Comma-delimited. Defaults to app,src.
LOWDOWN_WHITELISTNamespace whitelist. If set, documentation will be generated for only these namespaces. Comma-delimited.
Build your package's documentation:
Build your package's documentation with Gists included:
lowdown build --gist
Serve your package's documentation: