Layout Customization

Converge provides several pre-built layouts that are responsive and consistent with your theming customizations. Each layout offers a unique visual structure and user experience tailored for different documentation needs.

You may customize your documentation layout using the layout() function directly on the module:

use Converge\Module;
use Converge\Enums\Layout;
use Converge\Theme\Theme;

public function module(Module $module): Module
{
    return $module
                ->theme(function(Theme $theme) {
                     return $theme->layout(Layout::Default);
                }
}

Alternatively, you may extract your layout configuration into a separate method for better organization:

use Converge\Theme\Theme;
use Converge\Enums\Layout;
use Converge\Theme\Theme;


public function module(Module $module): Module
{
    return $module
                ->theme(fn(Theme $theme) => $this->theme($theme));
}

private function theme(Theme $theme)
{
    return $theme
              ->layout(Layout::Spacious);
}

Available Layouts

Converge offers five distinct layouts, each designed for specific use cases and aesthetic preferences: