Using Jigsaw from Tighten

🧠 Free Recall ❓ Quiz 🔍 Cues 🔮 Simulation 🥷 ShadowBox 📐 Encode Cards

Building Site

When you want to generate your static site from Jigsaw use ./vendor/bin/jigsaw build. This will place your site in the build_local directory

build directories
assets
	build
		css
		js
	images

To build for a certain environment use  ./vendor/bin/jigsaw build [environment_name] for example

./vendor/bin/jigsaw build production

This will create a directory called build_production

Configuration

config.php is the main configuration file for affecting the logic used when creating builds. To make configurations for specific environments, you can use the dot notation like config.production.php for the configuration details in production. The variables in configuration.production.php will be added to the variables in config.php and any duplicates will be overwritten.

For example, if some pages should have certain elements depending on the environment, you can set that in the config.php

Anything variables in your config.php will be available to all your templates. You can also provide helper methods in your config.php file to be used in templates

Compiling Assets

Jigsaw uses Laravel Mix for assets. Mix uses the assets found under /source/_assets to create the asset files found in the build directories

Mix looks for each asset type in a directory with the same name for instance .css files will be looked for in the /source/_assets/css folder

To refer to the assets files in your templates, use the mix helper and refer to the file.

To change asset locations check the webpack.mix.js file

Content

Content is controlled by either Laravel Blade Templates or Markdown

Templates are blade templates that have @yield directives where child templates can render their contents. 
Main layout templates can be placed in the source/_layouts

To extend a layout use @extend blade directive

To include a partial inside a template use @include. You can pass data to it just like in Laravel

Any file or folder prefixed with an underscore is never rendered by Jigsaw

Each page has access to page metadata using $page variable. Some helpful variables include 
$page->getPath();
$page->getUrl();

Configuration for content can be set in a YAML section at the top of a page like so 
---
extends: _layouts.post
section: postContent
title: "Jigsaw is awesome!"
author: "Adam Wathan"
---

Collections

Collections are a group of related pages. Collections give you the ability to access your content at an aggregate level so you can do things such as pagination, menus, tags, and categories

To define a collection add an array named collections to config.php with the name of the collection. Jigsaw will look for collection items in a directory with the same name as the collection. You can provide path settings to affect how the paths are displayed, and sort settings to affect how the collection is sorted, also in that collection array.

To create pages for each item in your collection, specify a parent template in the YAML settings on top of your content, or just use @extends

In all your blade templates you have access to all your collections which are really Laravel Collections

By default, the paths of the collection items will be /collection-name/collection-item

Routing

Any file not named index.blade.php will be rendered as index.html under a folder with the original .php name. For example about-us.blade.php will be rendered as source/about-us/index.html. You can disable this by using the --pretty=false  argument when building your site

404 Pages are possible using the permalink feature in a template. Just add permalink:404.html in your 404.blade.php file

Deploying

https://jigsaw.tighten.co/docs/deploying-your-site/

Unstarred

Dunk (exclude from study)

Using Jigsaw from Tighten

Review Questions

Todos

Sensemaker