Converge

Installation

Learn how to install Converge on your laravel application.

Prerequisites

Converge is written in PHP, JavaScript, and leverages several Laravel components. It is shipped as a Laravel package and requires the following:

  • PHP 8.3+
  • Laravel 11+
1

Installation

First you shoud install converge using composer

1composer require convergephp/converge
2

Generate new module provider

To start building documentation for your package or software, you need to create a Module Provider that will handle the configurationConverge includes a dedicated command to scaffold this for you.

1php artisan converge:make-module DocsModuleProvider
3

Publish the starterkit

This publishes a starter documentation structure with file conventions to help you get started quickly.

1php artisan vendor:publish --tag="converge-starterkit"
4

Visite your navigator

Open your browser and navigate to the route you configured to view your documentation (/docs).

1www.example.test/docs

Keep coding

Further Configuration

For additional configuration options, refer to the Module Provider documentation.

Previous
Overview
Next
Module provider
Powered by Converge