Skip to content

njpanderson/braid

Repository files navigation

Braid

Screenshot of Braid pattern library with a component loaded

What is Braid?

Braid is a pattern library tool for Laravel (+ Livewire) projects.

It enables developers to view components and markup in isolation, allowing for a consistent, clutter-free view of the atomic structure of their layouts.

Installing Braid

Braid can be installed via Composer:

$ composer require njpanderson/braid

Documentation

See the Braid documentation for more information.

To contribute to documentation, run docker from the project root with docker compose up (or docker-compose up). This should start Jekyll and a server which can display the current documentation in a browser.