Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
example/views
src
tests
.gitignore
LICENSE
README.md
blade
composer.json
phpunit.xml

README.md

Blade Builder

Blade Builder is simple yet powerful package that allows you to build static web sites from blade templates. Yes, by saying blade I mean Laravel blade templates. There are two ways of using this package. We'll get to this in usage section.

Installation

First run this composer command

composer require wilgucki/blade-builder

Having package installed, run init command from your project root.

./vendor/bin/blade init

If you want to preview your work, set document root of your web server to public directory.

Usage

As it was mentioned before, there are two ways of using this package.

  1. Preview tool for view files stored in view directory (perfect for your frontend team creating htmls for Laravel based project).
  2. Static html file generator.

In both cases you need to create blade templates inside views directory (feel free to create subdirectories). When you are done with writing your blade template, you can preview it in browser. Just type address you've configured for this project followed by template name. If you created some subdirectories, you need to use them as part of an address. For instance you have index.blade.php template inside views/about directory. Type http://your-address/about/index and you will see content built from your template. What just happened? Long story short - magic. Thanks to that magic you can preview all blade templates existing in views directory (with one exception - we'll get back to this soon).

What about second way? Well it's almost the same as the first one but instead of previewing templates in browser, you can generate static html files. Just run this command

./vendor/bin/blade build

Static html files are placed in compiled dir. Directory structure is the same as structure inside views dir.

Using json to fill templates with data

Writing templates can be pain in the ass, especially when dealing with tables or other repeated data. The code is bloated and hard to read. Fortunately you can use json to store data and use it inside blade templates. To do so you need to create json file named the same as blade template.

views
  index.blade.php
  index.json

Json file will be parsed and passed to blade template as associative array.

{
    "firstname": "John",
    "lastname": "Doe",
    "emails": ["mail1@mail.com", "mail2@mail.com"]
}

Above data will be visible in blade template as: $firstname, $lastname and $emails array.

But what if you want to populate more than one template with the same data? Instead of creating bunch od json files, you can use _global.json file. If exists this file is attached to all of blade templates. The contents of template json file are merged with _global.json so you are able to overwrite global values.

Conventions

As you might noticed, views directory contains two dirs starting with underscore: _layouts and _partials. These dirs and any other dir with name starting with underscore are excluded from building response. In other words these directories are invisible for users and static file builder. You can use them to store files like layouts and/or partial content (header, footer, etc.).

Example

Example dir contains simple web page built on top of Bootstrap Starter Template. Check it out to find out one of many ways how to use Blade Builder.