Download the PHP package elalecs/laravel-documenter without Composer

On this page you can find all versions of the php package elalecs/laravel-documenter. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of elalecs/laravel-documenter

Informations about the package laravel-documenter

Laravel Documenter

Laravel Documenter is an automated documentation generator for Laravel and Filament projects. Its primary purpose is to generate or extend the CONTRIBUTING.md file of your project, providing a comprehensive overview of your project's structure and components.

Features

Requirements

Installation

You can install the package via composer:

Configuration

Publish the configuration file:

This will create a config/laravel-documenter.php file where you can customize the behavior of the package.

Usage

To generate or update your project's CONTRIBUTING.md file:

This command will:

  1. Analyze your project structure
  2. Generate documentation for each component (Models, Filament Resources, etc.)
  3. Create or update the CONTRIBUTING.md file in your project root

You can also generate documentation for specific components:

Available types are: model, filament, api, and general.

Customization

You can customize the documentation output by publishing and modifying the stub files:

This will copy the stub files to your resources/views/vendor/laravel-documenter directory. After publishing, update your config/laravel-documenter.php file to point to your custom stubs:

Important: DocBlocks

For Laravel Documenter to function effectively, it's crucial that your code includes properly formatted DocBlocks. These DocBlocks should be present on:

Include @description tags in your DocBlocks to provide detailed information about the purpose and functionality of your components.

Example:

The more comprehensive your DocBlocks, the more detailed and useful the generated documentation will be.

Updating

When updating the package, make sure to republish the configuration file and clear the config cache:

Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

For more details on how to contribute, please check our CONTRIBUTING.md file.

License

The Laravel Documenter is open-sourced software licensed under the MIT license.

Credits

All versions of laravel-documenter with dependencies

PHP Build Version
Package Version
Requires php Version ^7.3|^8.0
laravel/framework Version ^8.0|^9.0|^10.0|^11.0
nikic/php-parser Version ^5.1
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package elalecs/laravel-documenter contains the following files

Loading the files please wait ....